mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-12-23 16:50:47 +00:00
Use proper GtkDoc notation for NULL/FALSE/TRUE
This commit is contained in:
parent
26cf8c1dc9
commit
0ddb65dec7
6 changed files with 11 additions and 11 deletions
|
@ -41,7 +41,7 @@
|
||||||
* purposes - just wait until the pipeline is prerolled (ASYNC_DONE message
|
* purposes - just wait until the pipeline is prerolled (ASYNC_DONE message
|
||||||
* on the bus), then read the property. If you use this method, you may want
|
* on the bus), then read the property. If you use this method, you may want
|
||||||
* to disable message posting by setting the #GstGdkPixbufSink:post-messages
|
* to disable message posting by setting the #GstGdkPixbufSink:post-messages
|
||||||
* property to #FALSE. This avoids unnecessary memory overhead.
|
* property to %FALSE. This avoids unnecessary memory overhead.
|
||||||
* </listitem>
|
* </listitem>
|
||||||
* </itemizedlist>
|
* </itemizedlist>
|
||||||
*
|
*
|
||||||
|
@ -60,7 +60,7 @@
|
||||||
* containing structures named <classname>"preroll-pixbuf"
|
* containing structures named <classname>"preroll-pixbuf"
|
||||||
* </classname> or <classname>"pixbuf"</classname> on the bus (this
|
* </classname> or <classname>"pixbuf"</classname> on the bus (this
|
||||||
* can be disabled by setting the #GstGdkPixbufSink:post-messages property
|
* can be disabled by setting the #GstGdkPixbufSink:post-messages property
|
||||||
* to #FALSE though). The element message structure has the following fields:
|
* to %FALSE though). The element message structure has the following fields:
|
||||||
* <itemizedlist>
|
* <itemizedlist>
|
||||||
* <listitem>
|
* <listitem>
|
||||||
* <classname>"pixbuf"</classname>: the #GdkPixbuf object
|
* <classname>"pixbuf"</classname>: the #GdkPixbuf object
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
* SECTION:element-level
|
* SECTION:element-level
|
||||||
*
|
*
|
||||||
* Level analyses incoming audio buffers and, if the #GstLevel:message property
|
* Level analyses incoming audio buffers and, if the #GstLevel:message property
|
||||||
* is #TRUE, generates an element message named
|
* is %TRUE, generates an element message named
|
||||||
* <classname>"level"</classname>:
|
* <classname>"level"</classname>:
|
||||||
* after each interval of time given by the #GstLevel:interval property.
|
* after each interval of time given by the #GstLevel:interval property.
|
||||||
* The message's structure contains these fields:
|
* The message's structure contains these fields:
|
||||||
|
|
|
@ -715,7 +715,7 @@ gst_matroska_mux_reset (GstElement * element)
|
||||||
*
|
*
|
||||||
* handle events - copied from oggmux without understanding
|
* handle events - copied from oggmux without understanding
|
||||||
*
|
*
|
||||||
* Returns: #TRUE on success.
|
* Returns: %TRUE on success.
|
||||||
*/
|
*/
|
||||||
static gboolean
|
static gboolean
|
||||||
gst_matroska_mux_handle_src_event (GstPad * pad, GstObject * parent,
|
gst_matroska_mux_handle_src_event (GstPad * pad, GstObject * parent,
|
||||||
|
@ -792,7 +792,7 @@ gst_matroska_mux_build_vobsub_private (GstMatroskaTrackContext * context,
|
||||||
*
|
*
|
||||||
* handle events - informational ones like tags
|
* handle events - informational ones like tags
|
||||||
*
|
*
|
||||||
* Returns: #TRUE on success.
|
* Returns: %TRUE on success.
|
||||||
*/
|
*/
|
||||||
static gboolean
|
static gboolean
|
||||||
gst_matroska_mux_handle_sink_event (GstCollectPads * pads,
|
gst_matroska_mux_handle_sink_event (GstCollectPads * pads,
|
||||||
|
@ -948,7 +948,7 @@ gst_matroska_mux_set_codec_id (GstMatroskaTrackContext * context,
|
||||||
*
|
*
|
||||||
* Setcaps function for video sink pad.
|
* Setcaps function for video sink pad.
|
||||||
*
|
*
|
||||||
* Returns: #TRUE on success.
|
* Returns: %TRUE on success.
|
||||||
*/
|
*/
|
||||||
static gboolean
|
static gboolean
|
||||||
gst_matroska_mux_video_pad_setcaps (GstPad * pad, GstCaps * caps)
|
gst_matroska_mux_video_pad_setcaps (GstPad * pad, GstCaps * caps)
|
||||||
|
@ -1760,7 +1760,7 @@ opus_make_codecdata (GstMatroskaTrackContext * context, GstCaps * caps)
|
||||||
*
|
*
|
||||||
* Setcaps function for audio sink pad.
|
* Setcaps function for audio sink pad.
|
||||||
*
|
*
|
||||||
* Returns: #TRUE on success.
|
* Returns: %TRUE on success.
|
||||||
*/
|
*/
|
||||||
static gboolean
|
static gboolean
|
||||||
gst_matroska_mux_audio_pad_setcaps (GstPad * pad, GstCaps * caps)
|
gst_matroska_mux_audio_pad_setcaps (GstPad * pad, GstCaps * caps)
|
||||||
|
@ -2181,7 +2181,7 @@ refuse_caps:
|
||||||
*
|
*
|
||||||
* Setcaps function for subtitle sink pad.
|
* Setcaps function for subtitle sink pad.
|
||||||
*
|
*
|
||||||
* Returns: #TRUE on success.
|
* Returns: %TRUE on success.
|
||||||
*/
|
*/
|
||||||
static gboolean
|
static gboolean
|
||||||
gst_matroska_mux_subtitle_pad_setcaps (GstPad * pad, GstCaps * caps)
|
gst_matroska_mux_subtitle_pad_setcaps (GstPad * pad, GstCaps * caps)
|
||||||
|
|
|
@ -40,7 +40,7 @@
|
||||||
* The filename property should contain a string with a \%d placeholder that will
|
* The filename property should contain a string with a \%d placeholder that will
|
||||||
* be substituted with the index for each filename.
|
* be substituted with the index for each filename.
|
||||||
*
|
*
|
||||||
* If the #GstMultiFileSink:post-messages property is #TRUE, it sends an application
|
* If the #GstMultiFileSink:post-messages property is %TRUE, it sends an application
|
||||||
* message named
|
* message named
|
||||||
* <classname>"GstMultiFileSink"</classname> after writing each
|
* <classname>"GstMultiFileSink"</classname> after writing each
|
||||||
* buffer.
|
* buffer.
|
||||||
|
|
|
@ -209,7 +209,7 @@ gst_rg_analysis_class_init (GstRgAnalysisClass * klass)
|
||||||
* skip the processing of streams that already contain the necessary tags.
|
* skip the processing of streams that already contain the necessary tags.
|
||||||
* Data will flow as usual but the element will not consume CPU time and will
|
* Data will flow as usual but the element will not consume CPU time and will
|
||||||
* not generate result tags. To enable possible skipping, set this property
|
* not generate result tags. To enable possible skipping, set this property
|
||||||
* to #FALSE.
|
* to %FALSE.
|
||||||
*
|
*
|
||||||
* If used in conjunction with <link linkend="GstRgAnalysis--num-tracks">album
|
* If used in conjunction with <link linkend="GstRgAnalysis--num-tracks">album
|
||||||
* processing</link>, the element will skip the number of remaining album
|
* processing</link>, the element will skip the number of remaining album
|
||||||
|
|
|
@ -22,7 +22,7 @@
|
||||||
* SECTION:element-spectrum
|
* SECTION:element-spectrum
|
||||||
*
|
*
|
||||||
* The Spectrum element analyzes the frequency spectrum of an audio signal.
|
* The Spectrum element analyzes the frequency spectrum of an audio signal.
|
||||||
* If the #GstSpectrum:post-messages property is #TRUE, it sends analysis results
|
* If the #GstSpectrum:post-messages property is %TRUE, it sends analysis results
|
||||||
* as element messages named
|
* as element messages named
|
||||||
* <classname>"spectrum"</classname> after each interval of time given
|
* <classname>"spectrum"</classname> after each interval of time given
|
||||||
* by the #GstSpectrum:interval property.
|
* by the #GstSpectrum:interval property.
|
||||||
|
|
Loading…
Reference in a new issue