Use proper GtkDoc notation for NULL/FALSE/TRUE
authorReynaldo H. Verdejo Pinochet <reynaldo@osg.samsung.com>
Mon, 2 Oct 2017 21:28:26 +0000 (14:28 -0700)
committerReynaldo H. Verdejo Pinochet <reynaldo@osg.samsung.com>
Tue, 3 Oct 2017 21:35:48 +0000 (14:35 -0700)
gst-libs/gst/adaptivedemux/gstadaptivedemux.h
gst/mpegtsmux/tsmux/tsmux.c
gst/videosignal/gstsimplevideomarkdetect.c
gst/videosignal/gstvideoanalyse.c
tests/check/elements/adaptive_demux_engine.h

index c507691..d59314c 100644 (file)
@@ -257,7 +257,7 @@ struct _GstAdaptiveDemuxClass
    * Parse the manifest and add the created streams using
    * gst_adaptive_demux_stream_new()
    *
-   * Returns: #TRUE if successful
+   * Returns: %TRUE if successful
    */
   gboolean      (*process_manifest) (GstAdaptiveDemux * demux, GstBuffer * manifest);
 
@@ -318,7 +318,7 @@ struct _GstAdaptiveDemuxClass
    * The demuxer should seek on all its streams to the specified position
    * in the seek event
    *
-   * Returns: #TRUE if successful
+   * Returns: %TRUE if successful
    */
   gboolean      (*seek)             (GstAdaptiveDemux * demux, GstEvent * seek);
 
@@ -331,7 +331,7 @@ struct _GstAdaptiveDemuxClass
    * this function is called to verify if there is a new period to be played
    * in sequence.
    *
-   * Returns: #TRUE if there is another period
+   * Returns: %TRUE if there is another period
    */
   gboolean      (*has_next_period)  (GstAdaptiveDemux * demux);
   /**
@@ -380,7 +380,7 @@ struct _GstAdaptiveDemuxClass
    * needs a caps change it should set the new caps using
    * gst_adaptive_demux_stream_set_caps().
    *
-   * Returns: #TRUE if the stream changed bitrate, #FALSE otherwise
+   * Returns: %TRUE if the stream changed bitrate, %FALSE otherwise
    */
   gboolean      (*stream_select_bitrate) (GstAdaptiveDemuxStream * stream, guint64 bitrate);
   /**
@@ -404,7 +404,7 @@ struct _GstAdaptiveDemuxClass
    * of a new fragment. Can be used to reset/init internal state that is
    * needed before each fragment, like decryption engines.
    *
-   * Returns: #TRUE if successful.
+   * Returns: %TRUE if successful.
    */
   gboolean      (*start_fragment) (GstAdaptiveDemux * demux, GstAdaptiveDemuxStream * stream);
   /**
index 24ae7e2..e13ee5f 100644 (file)
@@ -267,7 +267,7 @@ tsmux_get_si_interval (TsMux * mux)
  *
  * Add a Service Information #GstMpegtsSection to the stream
  *
- * Returns: #TRUE on success, #FALSE otherwise
+ * Returns: %TRUE on success, %FALSE otherwise
  */
 gboolean
 tsmux_add_mpegts_si_section (TsMux * mux, GstMpegtsSection * section)
index d58cff2..112d5d8 100644 (file)
  * After the pattern has been found and the data pattern has been read, an
  * element message called `GstSimpleVideoMarkDetect` will
  * be posted on the bus. If the pattern is no longer found in the frame, the
- * same element message is posted with the have-pattern field set to #FALSE.
- * The message is only posted if the #GstSimpleVideoMarkDetect:message property is #TRUE.
+ * same element message is posted with the have-pattern field set to %FALSE.
+ * The message is only posted if the #GstSimpleVideoMarkDetect:message property is %TRUE.
  *
  * The message's structure contains these fields:
  *
- * * #gboolean`have-pattern`: if the pattern was found. This field will be set to #TRUE for as long as
+ * * #gboolean`have-pattern`: if the pattern was found. This field will be set to %TRUE for as long as
  *   the pattern was found in the frame and set to FALSE for the first frame
  *   that does not contain the pattern anymore.
  *
@@ -51,7 +51,7 @@
  *
  * * #GstClockTime `duration`: the duration of the buffer.
  *
- * * #guint64 `data`: the data-pattern found after the pattern or 0 when have-signal is #FALSE.
+ * * #guint64 `data`: the data-pattern found after the pattern or 0 when have-signal is %FALSE.
  *
  * ## Example launch line
  * |[
index 2723c14..ab51f52 100644 (file)
@@ -21,7 +21,7 @@
  * @title: videoanalyse
  *
  * This plugin analyses every video frame and if the #GstVideoAnalyse:message
- * property is #TRUE, posts an element message with video statistics called
+ * property is %TRUE, posts an element message with video statistics called
  * `GstVideoAnalyse`.
  *
  * The message's structure contains these fields:
index 43bbc4c..b81161c 100644 (file)
@@ -73,7 +73,7 @@ typedef struct _GstAdaptiveDemuxTestCallbacks
    * @stream: #GstAdaptiveDemuxTestOutputStream
    * @buffer: the #GstBuffer that was recevied by #GstAppSink
    * @user_data: the user_data passed to gst_adaptive_demux_test_run()
-   * Returns: #TRUE to continue processing, #FALSE to cause EOS
+   * Returns: %TRUE to continue processing, %FALSE to cause EOS
    *
    * Can be used by a test to perform additional operations (eg validate
    * output data)