docs: Port all docstring to gtk-doc markdown
authorThibault Saunier <tsaunier@igalia.com>
Mon, 22 Oct 2018 09:47:32 +0000 (11:47 +0200)
committerThibault Saunier <tsaunier@igalia.com>
Sat, 27 Apr 2019 00:32:26 +0000 (20:32 -0400)
13 files changed:
ext/a52dec/gsta52dec.c
ext/amrnb/amrnbdec.c
ext/amrnb/amrnbenc.c
ext/amrwbdec/amrwbdec.c
ext/cdio/gstcdiocddasrc.c
ext/x264/gstx264enc.c
gst/asfdemux/gstasfdemux.h
gst/asfdemux/gstrtspwms.c
gst/realmedia/gstrdtbuffer.h
gst/realmedia/rademux.c
gst/realmedia/rdtmanager.c
gst/realmedia/rtspreal.c
gst/xingmux/gstxingmux.c

index 450152a7246a66127d86f408b81fa2e23afa4085..ccbf4d53848e7f2472b8244d9e41135000e7f3d8 100644 (file)
 
 /**
  * SECTION:element-a52dec
+ * @title: a52dec
  *
  * Dolby Digital (AC-3) audio decoder.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 dvdreadsrc title=1 ! mpegpsdemux ! a52dec ! audioconvert ! audioresample ! autoaudiosink
  * ]| Play audio part of a dvd title.
  * |[
  * gst-launch-1.0 filesrc location=abc.ac3 ! ac3parse ! a52dec ! audioconvert ! audioresample ! autoaudiosink
  * ]| Decode and play a stand alone AC-3 file.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index 8f2c422990cc87424717a0f99791eefb4cc3ebac..c5f2774c0e85a3175816b3347d984733d449cedc 100644 (file)
 
 /**
  * SECTION:element-amrnbdec
+ * @title: amrnbdec
  * @see_also: #GstAmrnbEnc, #GstAmrParse
  *
- * AMR narrowband decoder based on the 
+ * AMR narrowband decoder based on the
  * <ulink url="http://sourceforge.net/projects/opencore-amr">opencore codec implementation</ulink>.
- * 
- * <refsect2>
- * <title>Example launch line</title>
+ *
+ * ## Example launch line
  * |[
  * gst-launch-1.0 filesrc location=abc.amr ! amrparse ! amrnbdec ! audioconvert ! audioresample ! autoaudiosink
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index 2f72b9fb7476f8c2a0e4f2bbc6d6e367f258d9da..9c0f28560f8c5e544c5ab99d465943c2f117d64e 100644 (file)
 
 /**
  * SECTION:element-amrnbenc
+ * @title: amrnbenc
  * @see_also: #GstAmrnbDec, #GstAmrnbParse
  *
- * AMR narrowband encoder based on the 
+ * AMR narrowband encoder based on the
  * <ulink url="http://sourceforge.net/projects/opencore-amr">opencore codec implementation</ulink>.
- * 
- * <refsect2>
- * <title>Example launch line</title>
+ *
+ * ## Example launch line
  * |[
  * gst-launch-1.0 filesrc location=abc.wav ! wavparse ! audioconvert ! audioresample ! amrnbenc ! filesink location=abc.amr
  * ]|
  * Please note that the above stream misses the header, that is needed to play
  * the stream.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index cf05d95300b161cad9eab0d7f26989ea42ded07d..7832036c5470107cded7282f598d5751a7b9e522 100644 (file)
 
 /**
  * SECTION:element-amrwbdec
+ * @title: amrwbdec
  * @see_also: #GstAmrwbEnc
  *
- * AMR wideband decoder based on the 
+ * AMR wideband decoder based on the
  * <ulink url="http://sourceforge.net/projects/opencore-amr">opencore codec implementation</ulink>.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 filesrc location=abc.amr ! amrparse ! amrwbdec ! audioconvert ! audioresample ! autoaudiosink
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index 0990b500ac16277d71ea8efb83aca8371fc4803c..c82d0bd66896dca25857b601bfba91a07d4556ea 100644 (file)
 
 /**
  * SECTION:element-cdiocddasrc
+ * @title: cdiocddasrc
  * @see_also: GstCdParanoiaSrc, GstAudioCdSrc
  *
- * <refsect2>
- * <para>
  * cdiocddasrc reads and extracts raw audio from Audio CDs. It can operate
  * in one of two modes:
- * <itemizedlist>
- *  <listitem><para>
- *    treat each track as a separate stream, counting time from the start
+ *
+ *  * treat each track as a separate stream, counting time from the start
  *    of the track to the end of the track and posting EOS at the end of
  *    a track, or
- *  </para></listitem>
- *  <listitem><para>
- *    treat the entire disc as one stream, counting time from the start of
+ *  * treat the entire disc as one stream, counting time from the start of
  *    the first track to the end of the last track, posting EOS only at
  *    the end of the last track.
- *  </para></listitem>
- * </itemizedlist>
- * </para>
- * <para>
+ *
  * With a recent-enough version of libcdio, the element will extract
  * CD-TEXT if this is supported by the CD-drive and CD-TEXT information
  * is available on the CD. The information will be posted on the bus in
  * form of a tag message.
- * </para>
- * <para>
+ *
  * When opened, the element will also calculate a CDDB disc ID and a
  * MusicBrainz disc ID, which applications can use to query online
  * databases for artist/title information. These disc IDs will also be
  * posted on the bus as part of the tag messages.
- * </para>
- * <para>
+ *
  * cdiocddasrc supports the GstUriHandler interface, so applications can use
  * playbin with cdda://&lt;track-number&gt; URIs for playback (they will have
  * to connect to playbin's notify::source signal and set the device on the
  * Applications should use seeks in "track" format to switch between different
  * tracks of the same CD (passing a new cdda:// URI to playbin involves opening
  * and closing the CD device, which is much slower).
- * </para>
- * <title>Example launch line</title>
- * <para>
- * <programlisting>
+ *
+ * ## Example launch line
+ *
+ * |[
  * gst-launch-1.0 cdiocddasrc track=5 device=/dev/cdrom ! audioconvert ! vorbisenc ! oggmux ! filesink location=track5.ogg
- * </programlisting>
+ * ]|
  * This pipeline extracts track 5 of the audio CD and encodes it into an
  * Ogg/Vorbis file.
- * </para>
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index f313b21113a02e80a79eb1d4ee580d327baf4222..54bd7a1c5059a4e8e8d96c4cede5324cee571650 100644 (file)
@@ -22,6 +22,7 @@
 
 /**
  * SECTION:element-x264enc
+ * @title: x264enc
  * @see_also: faac
  *
  * This element encodes raw video into H264 compressed data,
  * applied, followed by the user-set properties, fast first pass restrictions and
  * finally the profile restrictions.
  *
- * <note>Some settings, including the default settings, may lead to quite
- * some latency (i.e. frame buffering) in the encoder. This may cause problems
- * with pipeline stalling in non-trivial pipelines, because the encoder latency
- * is often considerably higher than the default size of a simple queue
- * element. Such problems are caused by one of the queues in the other
- * non-x264enc streams/branches filling up and blocking upstream. They can
- * be fixed by relaxing the default time/size/buffer limits on the queue
- * elements in the non-x264 branches, or using a (single) multiqueue element
- * for all branches. Also see the last example below. You can also work around
- * this problem by setting the tune=zerolatency property, but this will affect
- * overall encoding quality so may not be appropriate for your use case.
- * </note>
+ * > Some settings, including the default settings, may lead to quite
+ * > some latency (i.e. frame buffering) in the encoder. This may cause problems
+ * > with pipeline stalling in non-trivial pipelines, because the encoder latency
+ * > is often considerably higher than the default size of a simple queue
+ * > element. Such problems are caused by one of the queues in the other
+ * > non-x264enc streams/branches filling up and blocking upstream. They can
+ * > be fixed by relaxing the default time/size/buffer limits on the queue
+ * > elements in the non-x264 branches, or using a (single) multiqueue element
+ * > for all branches. Also see the last example below. You can also work around
+ * > this problem by setting the tune=zerolatency property, but this will affect
+ * > overall encoding quality so may not be appropriate for your use case.
  *
- * <refsect2>
- * <title>Example pipeline</title>
+ * ## Example pipeline
  * |[
  * gst-launch-1.0 -v videotestsrc num-buffers=1000 ! x264enc qp-min=18 ! \
  *   avimux ! filesink location=videotestsrc.avi
@@ -92,7 +91,7 @@
  * specific settings are needed in this case to avoid pipeline stalling.
  * Depending on goals and context, other approaches are possible, e.g.
  * tune=zerolatency might be configured, or queue sizes increased.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index 953b4963d095ca5bd1a536ee4b46f32fa2f200bc..4e3dde3692aae88a8e38484b0488b15b4cfcd33f 100644 (file)
@@ -28,7 +28,7 @@
 #include "asfheaders.h"
 
 G_BEGIN_DECLS
-  
+
 #define GST_TYPE_ASF_DEMUX \
   (gst_asf_demux_get_type())
 #define GST_ASF_DEMUX(obj) \
@@ -70,7 +70,7 @@ enum _GstASF3DMode
   GST_ASF_3D_SIDE_BY_SIDE_HALF_RL = 0x02,
   GST_ASF_3D_TOP_AND_BOTTOM_HALF_LR = 0x03,
   GST_ASF_3D_TOP_AND_BOTTOM_HALF_RL = 0x04,
-  GST_ASF_3D_DUAL_STREAM = 0x0D,                  /**< Full format*/
+  GST_ASF_3D_DUAL_STREAM = 0x0D,                  /*< Full format*/
 };
 
 typedef struct
@@ -140,7 +140,7 @@ typedef struct
 
   /* extended stream properties (optional) */
   AsfStreamExtProps  ext_props;
-  
+
   gboolean     inspect_payload;
 } AsfStream;
 
@@ -231,7 +231,7 @@ struct _GstASFDemux {
   GstClockTime         sidx_interval;    /* interval between entries in ns */
   guint                sidx_num_entries; /* number of index entries        */
   AsfSimpleIndexEntry *sidx_entries;     /* packet number for each entry   */
-  
+
   GSList              *other_streams;    /* remember streams that are in header but have unknown type */
 
   /* For reverse playback */
index c864287e6aa05e4c8a841392ed0fa74c72bdd920..9d045a8d3a6778d4fc22418bd3695b94fe8be48a 100644 (file)
@@ -20,6 +20,7 @@
 
 /**
  * SECTION:element-rtspwms
+ * @title: rtspwms
  *
  * A WMS RTSP extension
  */
index 1ff9c93984471cec9ac878947e7570372da98bd9..fd1e067f8388aa1107492ab918ec663fe1a3825e 100644 (file)
@@ -26,8 +26,7 @@
 #include <gst/gst.h>
 
 G_BEGIN_DECLS
-
-/** 
+/**
  * GstRDTType:
  * @GST_RDT_TYPE_INVALID:
  * @GST_RDT_TYPE_ASMACTION:
@@ -63,7 +62,7 @@ typedef enum
 /**
  * GST_RDT_IS_DATA_TYPE:
  * @t: the #GstRDTType to check
- * 
+ *
  * Check if @t is a data packet type.
  */
 #define GST_RDT_IS_DATA_TYPE(t) ((t) < 0xff00)
@@ -75,14 +74,14 @@ typedef struct _GstRDTPacket GstRDTPacket;
  * @buffer: pointer to RDT buffer
  * @offset: offset of packet in buffer data
  *
- * Data structure that points to a packet at @offset in @buffer. 
+ * Data structure that points to a packet at @offset in @buffer.
  * The size of the structure is made public to allow stack allocations.
  */
 struct _GstRDTPacket
-{ 
+{
   GstBuffer   *buffer;
   guint        offset;
-  
+
   /*< private >*/
   GstRDTType   type;         /* type of current packet */
   guint16      length;       /* length of current packet in bytes */
index 3dadcc5082dd56e06f21358a91fc3277d6555946..d2ca9ae57e3f21fc57b886683c2806785be762fc 100644 (file)
 
 /**
  * SECTION:element-rademux
+ * @title: rademux
  *
  * Demuxes/parses a RealAudio (.ra) file or stream into compressed audio.
- * 
- * <refsect2>
- * <title>Example launch line</title>
+ *
+ * ## Example launch line
  * |[
  * gst-launch-1.0 filesrc location=interview.ra ! rademux ! avdec_real_288 ! audioconvert ! audioresample ! autoaudiosink
  * ]| Read a RealAudio file and decode it and output it to the soundcard using
@@ -32,7 +32,7 @@
  * gst-launch-1.0 souphttpsrc location=http://www.example.org/interview.ra ! rademux ! ac3parse ! a52dec ! audioconvert ! audioresample ! autoaudiosink
  * ]| Stream RealAudio data containing AC3 (dnet) compressed audio and decode it
  * and output it to the soundcard.
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H
index 48bc5ef4a77298a259b0bb8c8a3a99e7d5257270..742a6e2687e256765f64c2a4d4bf613dcadda007 100644 (file)
@@ -44,6 +44,7 @@
 
 /**
  * SECTION:element-rdtmanager
+ * @title: rdtmanager
  * @see_also: GstRtspSrc
  *
  * A simple RTP session manager used internally by rtspsrc.
index 8af70bec3a30a369c4615f9f010d6146adc4813c..fab3a4764fd347f4286ace35adc2cbfd16f653f3 100644 (file)
@@ -20,6 +20,7 @@
 
 /**
  * SECTION:element-rtspreal
+ * @title: rtspreal
  *
  * A RealMedia RTSP extension
  */
index b0809aa94ad376fc58dbd9ab8588c95c1fa71e75..38c1abbed5595cb35a24b1a5b7be6b83bbcf3a0d 100644 (file)
 
 /**
  * SECTION:element-xingmux
+ * @title: xingmux
  *
  * xingmux adds a Xing header to MP3 files. This contains information about the duration and size
  * of the file and a seek table and is very useful for getting an almost correct duration and better
  * seeking on VBR MP3 files.
- * 
+ *
  * This element will remove any existing Xing, LAME or VBRI headers from the beginning of the file.
  *
- * <refsect2>
- * <title>Example launch line</title>
+ * ## Example launch line
  * |[
  * gst-launch-1.0 audiotestsrc num-buffers=1000 ! audioconvert ! lamemp3enc ! xingmux ! filesink location=test.mp3
  * gst-launch-1.0 filesrc location=test.mp3 ! xingmux ! filesink location=test2.mp3
  * gst-launch-1.0 filesrc location=test.mp3 ! mp3parse ! xingmux ! filesink location=test2.mp3
  * ]|
- * </refsect2>
+ *
  */
 
 #ifdef HAVE_CONFIG_H