From e81c334ca9deeb5cb27ac60c272c217b7c3f216a Mon Sep 17 00:00:00 2001 From: "Reynaldo H. Verdejo Pinochet" Date: Tue, 3 Oct 2017 14:31:18 -0700 Subject: [PATCH] Use proper GtkDoc notation for NULL/FALSE/TRUE --- gst-libs/gst/audio/gstaudiodecoder.c | 2 +- gst-libs/gst/audio/gstaudioencoder.c | 2 +- gst-libs/gst/pbutils/encoding-profile.c | 4 ++-- gst-libs/gst/pbutils/gstdiscoverer-types.c | 2 +- gst-libs/gst/rtsp/gstrtspconnection.c | 22 +++++++++++----------- gst-libs/gst/rtsp/gstrtspmessage.c | 14 +++++++------- gst-libs/gst/rtsp/gstrtsptransport.c | 4 ++-- gst-libs/gst/video/gstvideodecoder.c | 2 +- gst-libs/gst/video/gstvideoencoder.c | 2 +- gst-libs/gst/video/gstvideopool.c | 2 +- gst-libs/gst/video/gstvideosink.c | 2 +- gst-libs/gst/video/video-color.c | 6 +++--- gst/playback/gstdecodebin2.c | 12 ++++++------ gst/playback/gstparsebin.c | 12 ++++++------ gst/playback/gsturidecodebin.c | 12 ++++++------ gst/playback/gsturisourcebin.c | 12 ++++++------ 16 files changed, 56 insertions(+), 56 deletions(-) diff --git a/gst-libs/gst/audio/gstaudiodecoder.c b/gst-libs/gst/audio/gstaudiodecoder.c index 333dbf9ebf..5dc6d49f7b 100644 --- a/gst-libs/gst/audio/gstaudiodecoder.c +++ b/gst-libs/gst/audio/gstaudiodecoder.c @@ -719,7 +719,7 @@ gst_audio_decoder_negotiate_unlocked (GstAudioDecoder * dec) * Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if * negotiate fails. * - * Returns: #TRUE if the negotiation succeeded, else #FALSE. + * Returns: %TRUE if the negotiation succeeded, else %FALSE. */ gboolean gst_audio_decoder_negotiate (GstAudioDecoder * dec) diff --git a/gst-libs/gst/audio/gstaudioencoder.c b/gst-libs/gst/audio/gstaudioencoder.c index 182d6a5496..2f690dd158 100644 --- a/gst-libs/gst/audio/gstaudioencoder.c +++ b/gst-libs/gst/audio/gstaudioencoder.c @@ -2800,7 +2800,7 @@ gst_audio_encoder_negotiate_unlocked (GstAudioEncoder * enc) * Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if * negotiate fails. * - * Returns: #TRUE if the negotiation succeeded, else #FALSE. + * Returns: %TRUE if the negotiation succeeded, else %FALSE. */ gboolean gst_audio_encoder_negotiate (GstAudioEncoder * enc) diff --git a/gst-libs/gst/pbutils/encoding-profile.c b/gst-libs/gst/pbutils/encoding-profile.c index 719ec9c2eb..94f741f51f 100644 --- a/gst-libs/gst/pbutils/encoding-profile.c +++ b/gst-libs/gst/pbutils/encoding-profile.c @@ -1156,7 +1156,7 @@ gst_encoding_container_profile_new (const gchar * name, /** * gst_encoding_video_profile_new: * @format: (transfer none): the #GstCaps - * @preset: (allow-none): the preset(s) to use on the encoder, can be #NULL + * @preset: (allow-none): the preset(s) to use on the encoder, can be %NULL * @restriction: (allow-none): the #GstCaps used to restrict the input to the encoder, can be * NULL. See gst_encoding_profile_get_restriction() for more details. * @presence: the number of time this stream must be used. 0 means any number of @@ -1187,7 +1187,7 @@ gst_encoding_video_profile_new (GstCaps * format, const gchar * preset, /** * gst_encoding_audio_profile_new: * @format: (transfer none): the #GstCaps - * @preset: (allow-none): the preset(s) to use on the encoder, can be #NULL + * @preset: (allow-none): the preset(s) to use on the encoder, can be %NULL * @restriction: (allow-none): the #GstCaps used to restrict the input to the encoder, can be * NULL. See gst_encoding_profile_get_restriction() for more details. * @presence: the number of time this stream must be used. 0 means any number of diff --git a/gst-libs/gst/pbutils/gstdiscoverer-types.c b/gst-libs/gst/pbutils/gstdiscoverer-types.c index 60a49cc59d..171ed6d583 100644 --- a/gst-libs/gst/pbutils/gstdiscoverer-types.c +++ b/gst-libs/gst/pbutils/gstdiscoverer-types.c @@ -899,7 +899,7 @@ VIDEO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0); * gst_discoverer_video_info_is_image: * @info: a #GstDiscovererVideoInfo * - * Returns: #TRUE if the video stream corresponds to an image (i.e. only contains + * Returns: %TRUE if the video stream corresponds to an image (i.e. only contains * one frame). */ gboolean diff --git a/gst-libs/gst/rtsp/gstrtspconnection.c b/gst-libs/gst/rtsp/gstrtspconnection.c index 484f2c4101..b1d5a568f3 100644 --- a/gst-libs/gst/rtsp/gstrtspconnection.c +++ b/gst-libs/gst/rtsp/gstrtspconnection.c @@ -870,7 +870,7 @@ remote_address_failed: * @response: a #GstRTSPMessage * * Attempt to connect to the url of @conn made with - * gst_rtsp_connection_create(). If @timeout is #NULL this function can block + * gst_rtsp_connection_create(). If @timeout is %NULL this function can block * forever. If @timeout contains a valid timeout, this function will return * #GST_RTSP_ETIMEOUT after the timeout expired. If @conn is set to tunneled, * @response will contain a response to the tunneling request messages. @@ -1060,7 +1060,7 @@ add_auth_header (GstRTSPConnection * conn, GstRTSPMessage * message) * @timeout: a #GTimeVal timeout * * Attempt to connect to the url of @conn made with - * gst_rtsp_connection_create(). If @timeout is #NULL this function can block + * gst_rtsp_connection_create(). If @timeout is %NULL this function can block * forever. If @timeout contains a valid timeout, this function will return * #GST_RTSP_ETIMEOUT after the timeout expired. * @@ -1409,10 +1409,10 @@ read_line (GstRTSPConnection * conn, guint8 * buffer, guint * idx, guint size, * @conn: a #GstRTSPConnection * @data: the data to write * @size: the size of @data - * @timeout: a timeout value or #NULL + * @timeout: a timeout value or %NULL * * Attempt to write @size bytes of @data to the connected @conn, blocking up to - * the specified @timeout. @timeout can be #NULL, in which case this function + * the specified @timeout. @timeout can be %NULL, in which case this function * might block forever. * * This function can be cancelled with gst_rtsp_connection_flush(). @@ -1549,10 +1549,10 @@ message_to_string (GstRTSPConnection * conn, GstRTSPMessage * message) * gst_rtsp_connection_send: * @conn: a #GstRTSPConnection * @message: the message to send - * @timeout: a timeout value or #NULL + * @timeout: a timeout value or %NULL * * Attempt to send @message to the connected @conn, blocking up to - * the specified @timeout. @timeout can be #NULL, in which case this function + * the specified @timeout. @timeout can be %NULL, in which case this function * might block forever. * * This function can be cancelled with gst_rtsp_connection_flush(). @@ -2127,10 +2127,10 @@ invalid_body_len: * @conn: a #GstRTSPConnection * @data: the data to read * @size: the size of @data - * @timeout: a timeout value or #NULL + * @timeout: a timeout value or %NULL * * Attempt to read @size bytes into @data from the connected @conn, blocking up to - * the specified @timeout. @timeout can be #NULL, in which case this function + * the specified @timeout. @timeout can be %NULL, in which case this function * might block forever. * * This function can be cancelled with gst_rtsp_connection_flush(). @@ -2206,10 +2206,10 @@ no_message: * gst_rtsp_connection_receive: * @conn: a #GstRTSPConnection * @message: the message to read - * @timeout: a timeout value or #NULL + * @timeout: a timeout value or %NULL * * Attempt to read into @message from the connected @conn, blocking up to - * the specified @timeout. @timeout can be #NULL, in which case this function + * the specified @timeout. @timeout can be %NULL, in which case this function * might block forever. * * This function can be cancelled with gst_rtsp_connection_flush(). @@ -2393,7 +2393,7 @@ gst_rtsp_connection_free (GstRTSPConnection * conn) * with #GST_RTSP_OK, @revents will contain a bitmask of available operations on * @conn. * - * @timeout can be #NULL, in which case this function might block forever. + * @timeout can be %NULL, in which case this function might block forever. * * This function can be cancelled with gst_rtsp_connection_flush(). * diff --git a/gst-libs/gst/rtsp/gstrtspmessage.c b/gst-libs/gst/rtsp/gstrtspmessage.c index c91a5e64ee..52e28534ab 100644 --- a/gst-libs/gst/rtsp/gstrtspmessage.c +++ b/gst-libs/gst/rtsp/gstrtspmessage.c @@ -199,7 +199,7 @@ gst_rtsp_message_init_request (GstRTSPMessage * msg, GstRTSPMethod method, * @version: (out) (allow-none): location to hold the version * * Parse the request message @msg and store the values @method, @uri and - * @version. The result locations can be #NULL if one is not interested in its + * @version. The result locations can be %NULL if one is not interested in its * value. * * @uri remains valid for as long as @msg is valid and unchanged. @@ -234,9 +234,9 @@ gst_rtsp_message_parse_request (GstRTSPMessage * msg, * Create a new response #GstRTSPMessage with @code and @reason and store the * result message in @msg. Free with gst_rtsp_message_free(). * - * When @reason is #NULL, the default reason for @code will be used. + * When @reason is %NULL, the default reason for @code will be used. * - * When @request is not #NULL, the relevant headers will be copied to the new + * When @request is not %NULL, the relevant headers will be copied to the new * response message. * * Returns: a #GstRTSPResult. @@ -265,9 +265,9 @@ gst_rtsp_message_new_response (GstRTSPMessage ** msg, GstRTSPStatusCode code, * * Initialize @msg with @code and @reason. * - * When @reason is #NULL, the default reason for @code will be used. + * When @reason is %NULL, the default reason for @code will be used. * - * When @request is not #NULL, the relevant headers will be copied to the new + * When @request is not %NULL, the relevant headers will be copied to the new * response message. * * Returns: a #GstRTSPResult. @@ -333,7 +333,7 @@ gst_rtsp_message_init_response (GstRTSPMessage * msg, GstRTSPStatusCode code, * @version: (out) (allow-none): location to hold the version * * Parse the response message @msg and store the values @code, @reason and - * @version. The result locations can be #NULL if one is not interested in its + * @version. The result locations can be %NULL if one is not interested in its * value. * * @reason remains valid for as long as @msg is valid and unchanged. @@ -904,7 +904,7 @@ gst_rtsp_message_get_body (const GstRTSPMessage * msg, guint8 ** data, * @size: (out): location for the size of @data * * Take the body of @msg and store it in @data and @size. After this method, - * the body and size of @msg will be set to #NULL and 0 respectively. + * the body and size of @msg will be set to %NULL and 0 respectively. * * Returns: #GST_RTSP_OK. */ diff --git a/gst-libs/gst/rtsp/gstrtsptransport.c b/gst-libs/gst/rtsp/gstrtsptransport.c index fa5393e7d6..b5c45745e3 100644 --- a/gst-libs/gst/rtsp/gstrtsptransport.c +++ b/gst-libs/gst/rtsp/gstrtsptransport.c @@ -282,7 +282,7 @@ get_default_lower_trans (GstRTSPTransport * transport) * It is possible that there are several managers available, use @option to * selected one. * - * @manager will contain an element name or #NULL when no manager is + * @manager will contain an element name or %NULL when no manager is * needed/available for @trans. * * Returns: #GST_RTSP_OK. @@ -587,7 +587,7 @@ invalid_transport: * Convert @transport into a string that can be used to signal the transport in * an RTSP SETUP response. * - * Returns: a string describing the RTSP transport or #NULL when the transport + * Returns: a string describing the RTSP transport or %NULL when the transport * is invalid. */ gchar * diff --git a/gst-libs/gst/video/gstvideodecoder.c b/gst-libs/gst/video/gstvideodecoder.c index d5d6263640..4d20a0efce 100644 --- a/gst-libs/gst/video/gstvideodecoder.c +++ b/gst-libs/gst/video/gstvideodecoder.c @@ -3883,7 +3883,7 @@ gst_video_decoder_negotiate_unlocked (GstVideoDecoder * decoder) * Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if * negotiate fails. * - * Returns: #TRUE if the negotiation succeeded, else #FALSE. + * Returns: %TRUE if the negotiation succeeded, else %FALSE. */ gboolean gst_video_decoder_negotiate (GstVideoDecoder * decoder) diff --git a/gst-libs/gst/video/gstvideoencoder.c b/gst-libs/gst/video/gstvideoencoder.c index f2bd5311a2..3274b8f131 100644 --- a/gst-libs/gst/video/gstvideoencoder.c +++ b/gst-libs/gst/video/gstvideoencoder.c @@ -1710,7 +1710,7 @@ gst_video_encoder_negotiate_unlocked (GstVideoEncoder * encoder) * Unmark GST_PAD_FLAG_NEED_RECONFIGURE in any case. But mark it again if * negotiate fails. * - * Returns: #TRUE if the negotiation succeeded, else #FALSE. + * Returns: %TRUE if the negotiation succeeded, else %FALSE. */ gboolean gst_video_encoder_negotiate (GstVideoEncoder * encoder) diff --git a/gst-libs/gst/video/gstvideopool.c b/gst-libs/gst/video/gstvideopool.c index de4c089547..b6d2dea2cc 100644 --- a/gst-libs/gst/video/gstvideopool.c +++ b/gst-libs/gst/video/gstvideopool.c @@ -71,7 +71,7 @@ gst_buffer_pool_config_set_video_alignment (GstStructure * config, * Get the video alignment from the bufferpool configuration @config in * in @align * - * Returns: #TRUE if @config could be parsed correctly. + * Returns: %TRUE if @config could be parsed correctly. */ gboolean gst_buffer_pool_config_get_video_alignment (GstStructure * config, diff --git a/gst-libs/gst/video/gstvideosink.c b/gst-libs/gst/video/gstvideosink.c index 3d74dbf0dc..9cfe780cc4 100644 --- a/gst-libs/gst/video/gstvideosink.c +++ b/gst-libs/gst/video/gstvideosink.c @@ -163,7 +163,7 @@ gst_video_sink_class_init (GstVideoSinkClass * klass) /** * GstVideoSink:show-preroll-frame: * - * Whether to show video frames during preroll. If set to #FALSE, video + * Whether to show video frames during preroll. If set to %FALSE, video * frames will only be rendered in PLAYING state. */ g_object_class_install_property (gobject_class, PROP_SHOW_PREROLL_FRAME, diff --git a/gst-libs/gst/video/video-color.c b/gst-libs/gst/video/video-color.c index 08513c8b7c..d3a3e4d03c 100644 --- a/gst-libs/gst/video/video-color.c +++ b/gst-libs/gst/video/video-color.c @@ -109,7 +109,7 @@ gst_video_get_colorimetry (const gchar * s) * Parse the colorimetry string and update @cinfo with the parsed * values. * - * Returns: #TRUE if @color points to valid colorimetry info. + * Returns: %TRUE if @color points to valid colorimetry info. */ gboolean gst_video_colorimetry_from_string (GstVideoColorimetry * cinfo, @@ -168,7 +168,7 @@ gst_video_colorimetry_to_string (const GstVideoColorimetry * cinfo) * Check if the colorimetry information in @info matches that of the * string @color. * - * Returns: #TRUE if @color conveys the same colorimetry info as the color + * Returns: %TRUE if @color conveys the same colorimetry info as the color * information in @info. */ gboolean @@ -253,7 +253,7 @@ gst_video_color_range_offsets (GstVideoColorRange range, * * Compare the 2 colorimetry sets for equality * - * Returns: #TRUE if @cinfo and @other are equal. + * Returns: %TRUE if @cinfo and @other are equal. * * Since: 1.6 */ diff --git a/gst/playback/gstdecodebin2.c b/gst/playback/gstdecodebin2.c index b17f124f63..c7d37717e3 100644 --- a/gst/playback/gstdecodebin2.c +++ b/gst/playback/gstdecodebin2.c @@ -720,11 +720,11 @@ gst_decode_bin_class_init (GstDecodeBinClass * klass) * emitted before looking for any elements that can handle that stream. * * > Invocation of signal handlers stops after the first signal handler - * > returns #FALSE. Signal handlers are invoked in the order they were + * > returns %FALSE. Signal handlers are invoked in the order they were * > connected in. * - * Returns: #TRUE if you wish decodebin to look for elements that can - * handle the given @caps. If #FALSE, those caps will be considered as + * Returns: %TRUE if you wish decodebin to look for elements that can + * handle the given @caps. If %FALSE, those caps will be considered as * final and the pad will be exposed as such (see 'pad-added' signal of * #GstElement). */ @@ -776,11 +776,11 @@ gst_decode_bin_class_init (GstDecodeBinClass * klass) * the application to perform additional sorting or filtering on the element * factory array. * - * The callee should copy and modify @factories or return #NULL if the + * The callee should copy and modify @factories or return %NULL if the * order should not change. * * > Invocation of signal handlers stops after one signal handler has - * > returned something else than #NULL. Signal handlers are invoked in + * > returned something else than %NULL. Signal handlers are invoked in * > the order they were connected in. * > Don't connect signal handlers with the #G_CONNECT_AFTER flag to this * > signal, they will never be invoked! @@ -847,7 +847,7 @@ gst_decode_bin_class_init (GstDecodeBinClass * klass) * be used to tell the element about the downstream supported caps * for example. * - * Returns: #TRUE if the query was handled, #FALSE otherwise. + * Returns: %TRUE if the query was handled, %FALSE otherwise. */ gst_decode_bin_signals[SIGNAL_AUTOPLUG_QUERY] = g_signal_new ("autoplug-query", G_TYPE_FROM_CLASS (klass), diff --git a/gst/playback/gstparsebin.c b/gst/playback/gstparsebin.c index 1d423172e7..0c59c79056 100644 --- a/gst/playback/gstparsebin.c +++ b/gst/playback/gstparsebin.c @@ -651,11 +651,11 @@ gst_parse_bin_class_init (GstParseBinClass * klass) * emitted before looking for any elements that can handle that stream. * * > Invocation of signal handlers stops after the first signal handler - * > returns #FALSE. Signal handlers are invoked in the order they were + * > returns %FALSE. Signal handlers are invoked in the order they were * > connected in. * - * Returns: #TRUE if you wish ParseBin to look for elements that can - * handle the given @caps. If #FALSE, those caps will be considered as + * Returns: %TRUE if you wish ParseBin to look for elements that can + * handle the given @caps. If %FALSE, those caps will be considered as * final and the pad will be exposed as such (see 'pad-added' signal of * #GstElement). */ @@ -707,11 +707,11 @@ gst_parse_bin_class_init (GstParseBinClass * klass) * the application to perform additional sorting or filtering on the element * factory array. * - * The callee should copy and modify @factories or return #NULL if the + * The callee should copy and modify @factories or return %NULL if the * order should not change. * * > Invocation of signal handlers stops after one signal handler has - * > returned something else than #NULL. Signal handlers are invoked in + * > returned something else than %NULL. Signal handlers are invoked in * > the order they were connected in. * > Don't connect signal handlers with the #G_CONNECT_AFTER flag to this * > signal, they will never be invoked! @@ -779,7 +779,7 @@ gst_parse_bin_class_init (GstParseBinClass * klass) * be used to tell the element about the downstream supported caps * for example. * - * Returns: #TRUE if the query was handled, #FALSE otherwise. + * Returns: %TRUE if the query was handled, %FALSE otherwise. */ gst_parse_bin_signals[SIGNAL_AUTOPLUG_QUERY] = g_signal_new ("autoplug-query", G_TYPE_FROM_CLASS (klass), diff --git a/gst/playback/gsturidecodebin.c b/gst/playback/gsturidecodebin.c index c523651f9b..d014c3e849 100644 --- a/gst/playback/gsturidecodebin.c +++ b/gst/playback/gsturidecodebin.c @@ -522,11 +522,11 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass) * emitted before looking for any elements that can handle that stream. * * > Invocation of signal handlers stops after the first signal handler - * > returns #FALSE. Signal handlers are invoked in the order they were + * > returns %FALSE. Signal handlers are invoked in the order they were * > connected in. * - * Returns: #TRUE if you wish uridecodebin to look for elements that can - * handle the given @caps. If #FALSE, those caps will be considered as + * Returns: %TRUE if you wish uridecodebin to look for elements that can + * handle the given @caps. If %FALSE, those caps will be considered as * final and the pad will be exposed as such (see 'pad-added' signal of * #GstElement). */ @@ -579,11 +579,11 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass) * the application to perform additional sorting or filtering on the element * factory array. * - * The callee should copy and modify @factories or return #NULL if the + * The callee should copy and modify @factories or return %NULL if the * order should not change. * * > Invocation of signal handlers stops after one signal handler has - * > returned something else than #NULL. Signal handlers are invoked in + * > returned something else than %NULL. Signal handlers are invoked in * > the order they were connected in. * > Don't connect signal handlers with the #G_CONNECT_AFTER flag to this * > signal, they will never be invoked! @@ -652,7 +652,7 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass) * be used to tell the element about the downstream supported caps * for example. * - * Returns: #TRUE if the query was handled, #FALSE otherwise. + * Returns: %TRUE if the query was handled, %FALSE otherwise. */ gst_uri_decode_bin_signals[SIGNAL_AUTOPLUG_QUERY] = g_signal_new ("autoplug-query", G_TYPE_FROM_CLASS (klass), diff --git a/gst/playback/gsturisourcebin.c b/gst/playback/gsturisourcebin.c index faf1d62b43..0986e5cccb 100644 --- a/gst/playback/gsturisourcebin.c +++ b/gst/playback/gsturisourcebin.c @@ -545,11 +545,11 @@ gst_uri_source_bin_class_init (GstURISourceBinClass * klass) * emitted before looking for any elements that can handle that stream. * * > Invocation of signal handlers stops after the first signal handler - * > returns #FALSE. Signal handlers are invoked in the order they were + * > returns %FALSE. Signal handlers are invoked in the order they were * > connected in. * - * Returns: #TRUE if you wish urisourcebin to look for elements that can - * handle the given @caps. If #FALSE, those caps will be considered as + * Returns: %TRUE if you wish urisourcebin to look for elements that can + * handle the given @caps. If %FALSE, those caps will be considered as * final and the pad will be exposed as such (see 'pad-added' signal of * #GstElement). */ @@ -602,11 +602,11 @@ gst_uri_source_bin_class_init (GstURISourceBinClass * klass) * the application to perform additional sorting or filtering on the element * factory array. * - * The callee should copy and modify @factories or return #NULL if the + * The callee should copy and modify @factories or return %NULL if the * order should not change. * * > Invocation of signal handlers stops after one signal handler has - * > returned something else than #NULL. Signal handlers are invoked in + * > returned something else than %NULL. Signal handlers are invoked in * > the order they were connected in. * > Don't connect signal handlers with the #G_CONNECT_AFTER flag to this * > signal, they will never be invoked! @@ -675,7 +675,7 @@ gst_uri_source_bin_class_init (GstURISourceBinClass * klass) * be used to tell the element about the downstream supported caps * for example. * - * Returns: #TRUE if the query was handled, #FALSE otherwise. + * Returns: %TRUE if the query was handled, %FALSE otherwise. */ gst_uri_source_bin_signals[SIGNAL_AUTOPLUG_QUERY] = g_signal_new ("autoplug-query", G_TYPE_FROM_CLASS (klass),