diff options
author | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-03-08 15:01:13 -0300 |
---|---|---|
committer | Thibault Saunier <thibault.saunier@osg.samsung.com> | 2017-04-12 12:57:57 -0300 |
commit | 78022a6e0c05ce482b798cf638cbd3f901a5094e (patch) | |
tree | 9725b5939d840f6eb3e8f39e032866e82413cb83 /gst | |
parent | 90f766cc518b4fde651162d6e0c7d190373e3c61 (diff) | |
download | gstreamer-plugins-bad-78022a6e0c05ce482b798cf638cbd3f901a5094e.tar.gz |
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'gst')
101 files changed, 384 insertions, 483 deletions
diff --git a/gst/accurip/gstaccurip.c b/gst/accurip/gstaccurip.c index f6423b7e6..05578d4e1 100644 --- a/gst/accurip/gstaccurip.c +++ b/gst/accurip/gstaccurip.c @@ -33,6 +33,7 @@ /** * SECTION:element-accurip + * @title: accurip * @short_desc: Computes an AccurateRip CRC * * The accurip element calculates a CRC for an audio stream which can be used @@ -40,12 +41,11 @@ * <ulink url="http://accuraterip.com/">AccurateRip</ulink>. This database * is used to check for a CD rip accuracy. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -m uridecodebin uri=file:///path/to/song.flac ! audioconvert ! accurip ! fakesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/aiff/aiffmux.c b/gst/aiff/aiffmux.c index 0f6d33036..96cac95bb 100644 --- a/gst/aiff/aiffmux.c +++ b/gst/aiff/aiffmux.c @@ -42,6 +42,7 @@ /** * SECTION:element-aiffmux + * @title: aiffmux * * Format an audio stream into the Audio Interchange File Format * diff --git a/gst/aiff/aiffparse.c b/gst/aiff/aiffparse.c index faa264770..b1b116703 100644 --- a/gst/aiff/aiffparse.c +++ b/gst/aiff/aiffparse.c @@ -23,30 +23,26 @@ /** * SECTION:element-aiffparse + * @title: aiffparse * - * <refsect2> - * <para> * Parse a .aiff file into raw or compressed audio. - * </para> - * <para> + * * The aiffparse element supports both push and pull mode operations, making it * possible to stream from a network source. - * </para> - * <title>Example launch line</title> - * <para> - * <programlisting> + * + * ## Example launch line + * + * |[ * gst-launch-1.0 filesrc location=sine.aiff ! aiffparse ! audioconvert ! alsasink - * </programlisting> + * ]| * Read a aiff file and output to the soundcard using the ALSA element. The * aiff file is assumed to contain raw uncompressed samples. - * </para> - * <para> - * <programlisting> + * + * |[ * gst-launch-1.0 souphttpsrc location=http://www.example.org/sine.aiff ! queue ! aiffparse ! audioconvert ! alsasink - * </programlisting> + * ]| * Stream data from a network url. - * </para> - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/asfmux/gstasfmux.c b/gst/asfmux/gstasfmux.c index 3579a554d..9896019ff 100644 --- a/gst/asfmux/gstasfmux.c +++ b/gst/asfmux/gstasfmux.c @@ -24,6 +24,7 @@ /** * SECTION:element-asfmux + * @title: asfmux * * Muxes media into an ASF file/stream. * @@ -31,9 +32,9 @@ * stream number of the stream that goes through that pad. Stream numbers * are assigned sequentially, starting from 1. * - * <refsect2> - * <title>Example launch lines</title> - * <para>(write everything in one line, without the backslash characters)</para> + * ## Example launch lines + * + * (write everything in one line, without the backslash characters) * |[ * gst-launch-1.0 videotestsrc num-buffers=250 \ * ! "video/x-raw,format=(string)I420,framerate=(fraction)25/1" ! avenc_wmv2 \ @@ -43,15 +44,15 @@ * ]| This creates an ASF file containing an WMV video stream * with a test picture and WMA audio stream of a test sound. * - * <title>Live streaming</title> + * ## Live streaming * asfmux and rtpasfpay are capable of generating a live asf stream. - * asfmux has to set its 'streamable' property to true, because in this + * asfmux has to set its 'streamable' property to true, because in this * mode it won't try to seek back to the start of the file to replace * some fields that couldn't be known at the file start. In this mode, * it won't also send indexes at the end of the data packets (the actual * media content) * the following pipelines are an example of this usage. - * <para>(write everything in one line, without the backslash characters)</para> + * (write everything in one line, without the backslash characters) * Server (sender) * |[ * gst-launch-1.0 -ve videotestsrc ! avenc_wmv2 ! asfmux name=mux streamable=true \ @@ -65,7 +66,7 @@ * ! videoconvert ! autovideosink \ * d. ! queue ! audioconvert ! autoaudiosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H @@ -421,7 +422,7 @@ content_description_calc_size_for_tag (const GstTagList * taglist, text = g_value_get_string (&value); /* +1 -> because of the \0 at the end - * 2* -> because we have uft8, and asf demands utf16 + * 2* -> because we have uft8, and asf demands utf16 */ content_size = 2 * (1 + g_utf8_strlen (text, -1)); @@ -442,7 +443,7 @@ content_description_calc_size_for_tag (const GstTagList * taglist, /* size of the tag content in utf16 + * size of the tag name + * 3 uint16 (size of the tag name string, - * size of the tag content string and + * size of the tag content string and * type of content */ asftags->ext_cont_desc_size += content_size + @@ -465,7 +466,7 @@ content_description_calc_size_for_tag (const GstTagList * taglist, * size needed for the default and extended content description objects. * This results and a copy of the #GstTagList * are stored in the #GstAsfTags. We store a copy so that - * the sizes estimated here mantain the same until they are + * the sizes estimated here mantain the same until they are * written to the asf file. */ static void @@ -531,7 +532,7 @@ add_metadata_tag_size (const GstTagList * taglist, const gchar * tag, text = g_value_get_string (&value); /* +1 -> because of the \0 at the end - * 2* -> because we have uft8, and asf demands utf16 + * 2* -> because we have uft8, and asf demands utf16 */ content_size = 2 * (1 + g_utf8_strlen (text, -1)); } @@ -849,7 +850,7 @@ gst_asf_mux_write_extended_stream_properties (GstAsfMux * asfmux, guint8 ** buf, * @size_buf: pointer to the memory position to write the size of the string * @str_buf: pointer to the memory position to write the string * @str: the string to be writen (in UTF-8) - * @use32: if the string size should be writen with 32 bits (if true) + * @use32: if the string size should be writen with 32 bits (if true) * or with 16 (if false) * * Writes a string with its size as it is needed in many asf objects. @@ -870,7 +871,7 @@ gst_asf_mux_write_string_with_size (GstAsfMux * asfmux, GST_LOG_OBJECT (asfmux, "Writing extended content description string: " "%s", str); - /* + /* * Covert the string to utf16 * Also force the last bytes to null terminated, * tags were with extra weird characters without it. @@ -909,7 +910,7 @@ gst_asf_mux_write_string_with_size (GstAsfMux * asfmux, * * Checks if a string tag with tagname exists in the taglist. If it * exists it is writen as an UTF-16LE to data_buf and its size in bytes - * is writen to size_buf. It is used for writing content description + * is writen to size_buf. It is used for writing content description * object fields. * * Returns: the size of the string @@ -1191,7 +1192,7 @@ gst_asf_mux_write_data_object (GstAsfMux * asfmux, guint8 ** buf) /* Data object size. This is always >= ASF_DATA_OBJECT_SIZE. The standard * specifically accepts the value 0 in live streams, but WMP is not accepting * this while streaming using WMSP, so we default to minimum size also for - * live streams. Otherwise this field must be updated later on when we know + * live streams. Otherwise this field must be updated later on when we know * the complete stream size. */ GST_WRITE_UINT64_LE (*buf + 16, ASF_DATA_OBJECT_SIZE); @@ -1338,7 +1339,7 @@ gst_asf_mux_start_file (GstAsfMux * asfmux) gst_asf_mux_write_header_object (asfmux, &bufdata, map.size - ASF_DATA_OBJECT_SIZE, 2 + stream_num); - /* get the position of the file properties object for + /* get the position of the file properties object for * updating it in gst_asf_mux_stop_file */ asfmux->file_properties_object_position = bufdata - map.data; gst_asf_mux_write_file_properties (asfmux, &bufdata); @@ -1765,7 +1766,7 @@ cleanup_and_return: /** * gst_asf_mux_stop_file: * @asfmux: #GstAsfMux - * + * * Finalizes the asf stream by pushing the indexes after * the data object. Also seeks back to the header positions * to rewrite some fields such as the total number of bytes @@ -1802,7 +1803,7 @@ gst_asf_mux_stop_file (GstAsfMux * asfmux) play_duration = pad->play_duration; } - /* going back to file properties object to fill in + /* going back to file properties object to fill in * values we didn't know back then */ GST_DEBUG_OBJECT (asfmux, "Sending new segment to file properties object position"); @@ -2134,7 +2135,7 @@ gst_asf_mux_audio_set_caps (GstPad * pad, GstCaps * caps) audiopad->audioinfo.rate = (guint32) rate; /* taken from avimux - * codec initialization data, if any + * codec initialization data, if any */ codec_data = gst_structure_get_value (structure, "codec_data"); if (codec_data) { @@ -2227,7 +2228,7 @@ gst_asf_mux_video_set_caps (GstPad * pad, GstCaps * caps) videopad->vidinfo.height = (gint32) height; /* taken from avimux - * codec initialization data, if any + * codec initialization data, if any */ codec_data = gst_structure_get_value (structure, "codec_data"); if (codec_data) { diff --git a/gst/asfmux/gstasfobjects.c b/gst/asfmux/gstasfobjects.c index c2b112926..f8455d970 100644 --- a/gst/asfmux/gstasfobjects.c +++ b/gst/asfmux/gstasfobjects.c @@ -58,7 +58,7 @@ const Guid guids[] = { /** * gst_asf_generate_file_id: - * + * * Generates a random GUID * * Returns: The generated GUID @@ -146,7 +146,7 @@ gst_asf_read_var_size_field (guint8 * data, guint8 field_type) /** * gst_asf_get_var_size_field_len: * @field_type: the asf field type - * + * * Returns: the size in bytes of a variable of field_type type */ guint @@ -168,7 +168,7 @@ gst_asf_get_var_size_field_len (guint8 field_type) * gst_asf_file_info_new: * * Creates a new #GstAsfFileInfo - * + * * Returns: the created struct */ GstAsfFileInfo * @@ -180,7 +180,7 @@ gst_asf_file_info_new (void) /** * gst_asf_file_info_reset: * @info: the #GstAsfFileInfo to be reset - * + * * resets the data of a #GstFileInfo */ void diff --git a/gst/audiofxbad/gstaudiochannelmix.c b/gst/audiofxbad/gstaudiochannelmix.c index 7d92a5b26..84e1049f7 100644 --- a/gst/audiofxbad/gstaudiochannelmix.c +++ b/gst/audiofxbad/gstaudiochannelmix.c @@ -18,18 +18,18 @@ */ /** * SECTION:element-gstaudiochannelmix + * @title: gstaudiochannelmix * * The audiochannelmix element mixes channels in stereo audio based on * properties set on the element. The primary purpose is reconstruct * equal left/right channels on an input stream that has audio in only * one channel. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v audiotestsrc ! audiochannelmix ! autoaudiosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/audiomixer/gstaudiointerleave.c b/gst/audiomixer/gstaudiointerleave.c index f4e9fa107..8d99b3ce1 100644 --- a/gst/audiomixer/gstaudiointerleave.c +++ b/gst/audiomixer/gstaudiointerleave.c @@ -27,7 +27,7 @@ */ /** * SECTION:element-audiointerleave - * + * @title: audiointerleave * */ @@ -593,7 +593,7 @@ gst_audio_interleave_class_init (GstAudioInterleaveClass * klass) /** * GstInterleave:channel-positions - * + * * Channel positions: This property controls the channel positions * that are used on the src caps. The number of elements should be * the same as the number of sink pads and the array should contain @@ -617,7 +617,7 @@ gst_audio_interleave_class_init (GstAudioInterleaveClass * klass) /** * GstInterleave:channel-positions-from-input - * + * * Channel positions from input: If this property is set to %TRUE the channel * positions will be taken from the input caps if valid channel positions for * the output can be constructed from them. If this is set to %TRUE setting the diff --git a/gst/audiomixer/gstaudiomixer.c b/gst/audiomixer/gstaudiomixer.c index de539db82..ac2f49c04 100644 --- a/gst/audiomixer/gstaudiomixer.c +++ b/gst/audiomixer/gstaudiomixer.c @@ -23,6 +23,7 @@ */ /** * SECTION:element-audiomixer + * @title: audiomixer * * The audiomixer allows to mix several streams into one by adding the data. * Mixed data is clamped to the min/max values of the data format. @@ -32,21 +33,13 @@ * The input pads are from a GstPad subclass and have additional * properties to mute each pad individually and set the volume: * - * <itemizedlist> - * <listitem> - * "mute": Whether to mute the pad or not (#gboolean) - * </listitem> - * <listitem> - * "volume": The volume of the pad, between 0.0 and 10.0 (#gdouble) - * </listitem> - * </itemizedlist> + * * "mute": Whether to mute the pad or not (#gboolean) + * * "volume": The volume of the pad, between 0.0 and 10.0 (#gdouble) * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc freq=100 ! audiomixer name=mix ! audioconvert ! alsasink audiotestsrc freq=500 ! mix. * ]| This pipeline produces two sine waves mixed together. - * </refsect2> * */ diff --git a/gst/audiomixmatrix/gstaudiomixmatrix.c b/gst/audiomixmatrix/gstaudiomixmatrix.c index 6dd59ffd9..75f4a970a 100644 --- a/gst/audiomixmatrix/gstaudiomixmatrix.c +++ b/gst/audiomixmatrix/gstaudiomixmatrix.c @@ -22,6 +22,7 @@ /** * SECTION:element-audiomixmatrix + * @title: audiomixmatrix * @short_description: Transform input/output channels according to a matrix * * This element transforms a given number of input channels into a given @@ -32,8 +33,7 @@ * are automatically negotiated and the transformation matrix is a truncated * identity matrix. * - * <refsect2> - * <title>Example matrix generation code</title> + * ## Example matrix generation code * To generate the matrix using code: * * |[ @@ -54,14 +54,12 @@ * g_object_set_property (G_OBJECT (audiomixmatrix), "matrix", &v); * g_value_unset (&v); * ]| - * </refsect2> * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audio/x-raw,channels=4 ! audiomixmatrix in-channels=4 out-channels=2 channel-mask=-1 matrix="<<(double)1, (double)0, (double)0, (double)0>, <0.0, 1.0, 0.0, 0.0>>" ! audio/x-raw,channels=2 ! autoaudiosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/audiovisualizers/gstspacescope.c b/gst/audiovisualizers/gstspacescope.c index 5071dc8b1..3e59609f3 100644 --- a/gst/audiovisualizers/gstspacescope.c +++ b/gst/audiovisualizers/gstspacescope.c @@ -20,17 +20,17 @@ */ /** * SECTION:element-spacescope + * @title: spacescope * @see_also: goom * * Spacescope is a simple audio visualisation element. It maps the left and * right channel to x and y coordinates. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audioconvert ! spacescope ! ximagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/audiovisualizers/gstspectrascope.c b/gst/audiovisualizers/gstspectrascope.c index 10aa7d2f8..5ba73ba11 100644 --- a/gst/audiovisualizers/gstspectrascope.c +++ b/gst/audiovisualizers/gstspectrascope.c @@ -21,17 +21,17 @@ */ /** * SECTION:element-spectrascope + * @title: spectrascope * @see_also: goom * * Spectrascope is a simple spectrum visualisation element. It renders the * frequency spectrum as a series of bars. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audioconvert ! spectrascope ! ximagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/audiovisualizers/gstsynaescope.c b/gst/audiovisualizers/gstsynaescope.c index f99a753ea..4b5c0ed5a 100644 --- a/gst/audiovisualizers/gstsynaescope.c +++ b/gst/audiovisualizers/gstsynaescope.c @@ -20,17 +20,17 @@ */ /** * SECTION:element-synaescope + * @title: synaescope * @see_also: goom * * Synaescope is an audio visualisation element. It analyzes frequencies and * out-of phase properties of audio and draws this as clouds of stars. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audioconvert ! synaescope ! ximagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/audiovisualizers/gstwavescope.c b/gst/audiovisualizers/gstwavescope.c index e4eb8c2fb..c934daa4d 100644 --- a/gst/audiovisualizers/gstwavescope.c +++ b/gst/audiovisualizers/gstwavescope.c @@ -20,17 +20,17 @@ */ /** * SECTION:element-wavescope + * @title: wavescope * @see_also: goom * * Wavescope is a simple audio visualisation element. It renders the waveforms * like on an oscilloscope. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc ! audioconvert ! wavescope ! ximagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/gst/autoconvert/gstautoconvert.c b/gst/autoconvert/gstautoconvert.c index 4761f4403..bed5e88e7 100644 --- a/gst/autoconvert/gstautoconvert.c +++ b/gst/autoconvert/gstautoconvert.c @@ -21,6 +21,7 @@ */ /** * SECTION:element-autoconvert + * @title: autoconvert * * The #autoconvert element has one sink and one source pad. It will look for * other elements that also have one sink and one source pad. diff --git a/gst/bayer/gstbayer2rgb.c b/gst/bayer/gstbayer2rgb.c index de356edff..a6d24eab1 100644 --- a/gst/bayer/gstbayer2rgb.c +++ b/gst/bayer/gstbayer2rgb.c @@ -23,6 +23,7 @@ /** * SECTION:element-bayer2rgb + * @title: bayer2rgb * * Decodes raw camera bayer (fourcc BA81) to RGB. */ diff --git a/gst/camerabin2/camerabingeneral.c b/gst/camerabin2/camerabingeneral.c index 45a0df46a..799c86d3a 100644 --- a/gst/camerabin2/camerabingeneral.c +++ b/gst/camerabin2/camerabingeneral.c @@ -20,6 +20,7 @@ /** * SECTION:camerabingeneral + * @title: GstCameraBin2 * @short_description: helper functions for #GstCameraBin2 and it's modules * * Common helper functions for #GstCameraBin2, #GstCameraBin2Image and diff --git a/gst/camerabin2/gstcamerabin2.c b/gst/camerabin2/gstcamerabin2.c index 24bb4fbda..0e4a3c727 100644 --- a/gst/camerabin2/gstcamerabin2.c +++ b/gst/camerabin2/gstcamerabin2.c @@ -18,33 +18,22 @@ */ /** * SECTION:element-camerabin + * @title: camerabin * * CameraBin is a high-level camera object that encapsulates gstreamer * elements, providing an API for controlling a digital camera. * - * <note> - * Note that camerabin is still UNSTABLE and under development. - * </note> + * > Note that camerabin is still UNSTABLE and under development. * * CameraBin has the following main features: - * <itemizedlist> - * <listitem> - * Record videos - * </listitem> - * <listitem> - * Capture pictures - * </listitem> - * <listitem> - * Display a viewfinder - * </listitem> - * <listitem> - * Post preview images for each capture (video and image) - * </listitem> - * </itemizedlist> * - * <refsect2> - * <title>Usage</title> - * <para> + * * Record videos + * * Capture pictures + * * Display a viewfinder + * * Post preview images for each capture (video and image) + * + * ## Usage + * * Camerabin can be created using gst_element_factory_make() just like * any other element. Video or image capture mode can be selected using * the #GstCameraBin:mode property and the file to save the capture is @@ -69,12 +58,11 @@ * In both modes, if #GstCameraBin:post-previews is %TRUE, a #GstBuffer * will be post to the #GstBus in a field named 'buffer', in a * 'preview-image' message of type %GST_MESSAGE_ELEMENT. - * </para> - * </refsect2> + * - * <refsect2> - * <title>Customization</title> - * <para> + * + * ## Customization + * * Camerabin provides various customization properties, allowing the user * to set custom filters, selecting the viewfinder sink and formats to * use to encode the captured images/videos. @@ -114,20 +102,16 @@ * of its branches: video capture, image capture, viewfinder and preview. * Check #GstCameraBin:video-filter, #GstCameraBin:image-filter, * #GstCameraBin:viewfinder-filter and #GstCameraBin:preview-filter. - * </para> - * </refsect2> * - * <refsect2> - * <title>Example launch line</title> - * <para> + * ## Example launch line + * * Unfortunately, camerabin can't be really used from gst-launch-1.0, as you * need to send signals to control it. The following pipeline might be able * to show the viewfinder using all the default elements. * |[ * gst-launch-1.0 -v -m camerabin * ]| - * </para> - * </refsect2> + * */ diff --git a/gst/camerabin2/gstdigitalzoom.c b/gst/camerabin2/gstdigitalzoom.c index b936fe455..c7de9a650 100644 --- a/gst/camerabin2/gstdigitalzoom.c +++ b/gst/camerabin2/gstdigitalzoom.c @@ -21,6 +21,7 @@ /** * SECTION:element-digitalzoom + * @title: digitalzoom * * Does digital zooming by cropping and scaling an image. * diff --git a/gst/camerabin2/gstviewfinderbin.c b/gst/camerabin2/gstviewfinderbin.c index 7ff7bd509..1d3da329a 100644 --- a/gst/camerabin2/gstviewfinderbin.c +++ b/gst/camerabin2/gstviewfinderbin.c @@ -18,16 +18,16 @@ */ /** * SECTION:element-gstviewfinderbin + * @title: gstviewfinderbin * * The gstviewfinderbin element is a displaying element for camerabin2. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! viewfinderbin * ]| * Feeds the viewfinderbin with video test data. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/camerabin2/gstwrappercamerabinsrc.c b/gst/camerabin2/gstwrappercamerabinsrc.c index 4c2d8ec12..c1c6dc5ee 100644 --- a/gst/camerabin2/gstwrappercamerabinsrc.c +++ b/gst/camerabin2/gstwrappercamerabinsrc.c @@ -22,6 +22,7 @@ /** * SECTION:element-wrappercamerabinsrc + * @title: wrappercamerabinsrc * * A camera bin src element that wraps a default video source with a single * pad into the 3pad model that camerabin2 expects. diff --git a/gst/coloreffects/gstchromahold.c b/gst/coloreffects/gstchromahold.c index 011c401ee..1ddb4c072 100644 --- a/gst/coloreffects/gstchromahold.c +++ b/gst/coloreffects/gstchromahold.c @@ -23,7 +23,8 @@ /** * SECTION:element-chromahold - * + * @title: chromahold + * * The chromahold element will remove all color information for * all colors except a single one and converts them to grayscale. * diff --git a/gst/coloreffects/gstcoloreffects.c b/gst/coloreffects/gstcoloreffects.c index 5a1aea110..dc26f70dd 100644 --- a/gst/coloreffects/gstcoloreffects.c +++ b/gst/coloreffects/gstcoloreffects.c @@ -19,16 +19,16 @@ /** * SECTION:element-coloreffects + * @title: coloreffects * * Map colors of the video input to a lookup table * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! coloreffects preset=heat ! videoconvert ! * autovideosink * ]| This pipeline shows the effect of coloreffects on a test stream. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/compositor/compositor.c b/gst/compositor/compositor.c index 068d2bb72..fab75c639 100644 --- a/gst/compositor/compositor.c +++ b/gst/compositor/compositor.c @@ -22,6 +22,7 @@ /** * SECTION:element-compositor + * @title: compositor * * Compositor can accept AYUV, ARGB and BGRA video streams. For each of the requested * sink pads it will compare the incoming geometry and framerate to define the @@ -29,40 +30,19 @@ * biggest incoming video stream and the framerate of the fastest incoming one. * * Compositor will do colorspace conversion. - * + * * Individual parameters for each input stream can be configured on the * #GstCompositorPad: * - * <itemizedlist> - * <listitem> - * "xpos": The x-coordinate position of the top-left corner of the picture - * (#gint) - * </listitem> - * <listitem> - * "ypos": The y-coordinate position of the top-left corner of the picture - * (#gint) - * </listitem> - * <listitem> - * "width": The width of the picture; the input will be scaled if necessary - * (#gint) - * </listitem> - * <listitem> - * "height": The height of the picture; the input will be scaled if necessary - * (#gint) - * </listitem> - * <listitem> - * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending - * is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). - * (#gdouble) - * </listitem> - * <listitem> - * "zorder": The z-order position of the picture in the composition - * (#guint) - * </listitem> - * </itemizedlist> + * * "xpos": The x-coordinate position of the top-left corner of the picture (#gint) + * * "ypos": The y-coordinate position of the top-left corner of the picture (#gint) + * * "width": The width of the picture; the input will be scaled if necessary (#gint) + * * "height": The height of the picture; the input will be scaled if necessary (#gint) + * * "alpha": The transparency of the picture; between 0.0 and 1.0. The blending + * is a simple copy when fully-transparent (0.0) and fully-opaque (1.0). (#gdouble) + * * "zorder": The z-order position of the picture in the composition (#guint) * - * <refsect2> - * <title>Sample pipelines</title> + * ## Sample pipelines * |[ * gst-launch-1.0 \ * videotestsrc pattern=1 ! \ @@ -85,7 +65,7 @@ * compositor name=comp ! videoconvert ! ximagesink \ * videotestsrc ! \ * video/x-raw, framerate=\(fraction\)5/1, width=320, height=240 ! comp. - * ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending). + * ]| A pipeline to demostrate bgra comping. (This does not demonstrate alpha blending). * |[ * gst-launch-1.0 videotestsrc pattern=1 ! \ * video/x-raw,format =I420, framerate=\(fraction\)10/1, width=100, height=100 ! \ @@ -103,7 +83,7 @@ * "video/x-raw,format=AYUV,width=800,height=600,framerate=(fraction)10/1" ! \ * timeoverlay ! queue2 ! comp. * ]| A pipeline to demonstrate synchronized compositing (the second stream starts after 3 seconds) - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/fpsdisplaysink.c b/gst/debugutils/fpsdisplaysink.c index 00f89a3e7..9774b6a52 100644 --- a/gst/debugutils/fpsdisplaysink.c +++ b/gst/debugutils/fpsdisplaysink.c @@ -19,18 +19,18 @@ /** * SECTION:element-fpsdisplaysink + * @title: fpsdisplaysink * * Can display the current and average framerate as a testoverlay or on stdout. * - * <refsect2> - * <title>Example launch lines</title> + * ## Example launch lines * |[ * gst-launch-1.0 videotestsrc ! fpsdisplaysink * gst-launch-1.0 videotestsrc ! fpsdisplaysink text-overlay=false * gst-launch-1.0 filesrc location=video.avi ! decodebin name=d ! queue ! fpsdisplaysink d. ! queue ! fakesink sync=true * gst-launch-1.0 playbin uri=file:///path/to/video.avi video-sink="fpsdisplaysink" audio-sink=fakesink * ]| - * </refsect2> + * */ /* FIXME: * - can we avoid plugging the textoverlay? diff --git a/gst/debugutils/gstchopmydata.c b/gst/debugutils/gstchopmydata.c index c382d3274..bed08befb 100644 --- a/gst/debugutils/gstchopmydata.c +++ b/gst/debugutils/gstchopmydata.c @@ -18,26 +18,25 @@ */ /** * SECTION:element-gstchopmydata + * @title: gstchopmydata * * The chopmydata element takes an incoming stream and chops it up * into randomly sized buffers. Size of outgoing buffers are determined * by the max-size, min-size, and step-size properties. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v audiotestsrc num-buffers=10 ! chopmydata min-size=100 * max-size=200 step-size=2 ! fakesink -v * ]| - * + * * This pipeline will create 10 buffers that are by default 2048 bytes * each (1024 samples each), and chop them up into buffers that range * in size from 100 bytes to 200 bytes, with the restriction that sizes * are a multiple of 2. This restriction is important, because the * default sample size for audiotestsrc is 2 bytes (one channel, 16-bit * audio). - * - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gstdebugspy.c b/gst/debugutils/gstdebugspy.c index fed2db180..ebf050f6d 100644 --- a/gst/debugutils/gstdebugspy.c +++ b/gst/debugutils/gstdebugspy.c @@ -22,16 +22,16 @@ /** * SECTION:element-debugspy + * @title: debugspy * * A spy element that can provide information on buffers going through it, with * bus messages. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -m videotestsrc ! debugspy ! fakesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gsterrorignore.c b/gst/debugutils/gsterrorignore.c index ed42a0505..30e5beee2 100644 --- a/gst/debugutils/gsterrorignore.c +++ b/gst/debugutils/gsterrorignore.c @@ -20,17 +20,18 @@ /** * SECTION:element-errorignore + * @title: errorignore * * Passes through all packets, until it encounters GST_FLOW_ERROR or * GST_FLOW_NOT_NEGOTIATED (configurable). At that point it will unref the - * buffers and return GST_FLOW_OK (configurable) - until the next + * buffers and return GST_FLOW_OK (configurable) - until the next * READY_TO_PAUSED, RECONFIGURE or FLUSH_STOP. - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! errorignore ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/debugutils/gstwatchdog.c b/gst/debugutils/gstwatchdog.c index 0a4c12e7b..1824cbf3b 100644 --- a/gst/debugutils/gstwatchdog.c +++ b/gst/debugutils/gstwatchdog.c @@ -19,6 +19,7 @@ */ /** * SECTION:element-gstwatchdog + * @title: watchdog * * The watchdog element watches buffers and events flowing through * a pipeline. If no buffers are seen for a configurable amount of @@ -32,12 +33,11 @@ * This element is currently intended for transcoding pipelines, * although may be useful in other contexts. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v fakesrc ! watchdog ! fakesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/dvbsuboverlay/dvb-sub.c b/gst/dvbsuboverlay/dvb-sub.c index 75965631a..cddb19ec9 100644 --- a/gst/dvbsuboverlay/dvb-sub.c +++ b/gst/dvbsuboverlay/dvb-sub.c @@ -45,6 +45,7 @@ static void dvb_sub_init (void); /** * SECTION:dvb-sub + * @title: GstDvbSub * @short_description: a DVB subtitle parsing class * @stability: Unstable * diff --git a/gst/dvbsuboverlay/dvb-sub.h b/gst/dvbsuboverlay/dvb-sub.h index 7faa31f45..5917e7e49 100644 --- a/gst/dvbsuboverlay/dvb-sub.h +++ b/gst/dvbsuboverlay/dvb-sub.h @@ -68,7 +68,7 @@ typedef struct DVBSubtitleRect { /** * DVBSubtitleWindow - * @version: version + * @version: version * @display_window_flag: window_* are valid * @display_width: assumed width of display * @display_height: assumed height of display diff --git a/gst/dvbsuboverlay/gstdvbsuboverlay.c b/gst/dvbsuboverlay/gstdvbsuboverlay.c index 1723cae92..f28590cd9 100644 --- a/gst/dvbsuboverlay/gstdvbsuboverlay.c +++ b/gst/dvbsuboverlay/gstdvbsuboverlay.c @@ -20,17 +20,17 @@ /** * SECTION:element-dvbsuboverlay + * @title: dvbsuboverlay * * Renders DVB subtitles on top of a video stream. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ FIXME * gst-launch-1.0 -v filesrc location=/path/to/ts ! mpegtsdemux name=d ! queue ! mpegaudioparse ! mpg123audiodec ! audioconvert ! autoaudiosink \ * d. ! queue ! mpegvideoparse ! mpeg2dec ! videoconvert ! r. \ * d. ! queue ! "subpicture/x-dvb" ! dvbsuboverlay name=r ! videoconvert ! autovideosink * ]| This pipeline demuxes a MPEG-TS file with MPEG2 video, MP3 audio and embedded DVB subtitles and renders the subtitles on top of the video. - * </refsect2> + * */ diff --git a/gst/dvdspu/gstdvdspu.c b/gst/dvdspu/gstdvdspu.c index fb2174890..41c964b0d 100644 --- a/gst/dvdspu/gstdvdspu.c +++ b/gst/dvdspu/gstdvdspu.c @@ -18,15 +18,15 @@ */ /** * SECTION:element-dvdspu + * @title: dvdspu * * DVD sub picture overlay element. - * - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * FIXME: gst-launch-1.0 ... * ]| FIXME: description for the sample launch pipeline - * </refsect2> + * */ #ifdef HAVE_CONFIG_H # include <config.h> diff --git a/gst/festival/gstfestival.c b/gst/festival/gstfestival.c index 981ec6112..73d492ab8 100644 --- a/gst/festival/gstfestival.c +++ b/gst/festival/gstfestival.c @@ -62,18 +62,18 @@ /** * SECTION:element-festival - * + * @title: festival + * * This element connects to a * <ulink url="http://www.festvox.org/festival/index.html">festival</ulink> * server process and uses it to synthesize speech. Festival need to run already * in server mode, started as <screen>festival --server</screen> - * - * <refsect2> - * <title>Example pipeline</title> + * + * ## Example pipeline * |[ * echo 'Hello G-Streamer!' | gst-launch-1.0 fdsrc fd=0 ! festival ! wavparse ! audioconvert ! alsasink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/fieldanalysis/gstfieldanalysis.c b/gst/fieldanalysis/gstfieldanalysis.c index 2b01b5180..d1ef181a6 100644 --- a/gst/fieldanalysis/gstfieldanalysis.c +++ b/gst/fieldanalysis/gstfieldanalysis.c @@ -43,17 +43,17 @@ /** * SECTION:element-fieldanalysis + * @title: fieldanalysis * * Analyse fields from video buffers to identify whether the buffers are * progressive/telecined/interlaced and, if telecined, the telecine pattern * used. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v uridecodebin uri=/path/to/foo.bar ! fieldanalysis ! deinterlace ! videoconvert ! autovideosink * ]| This pipeline will analyse a video stream with default metrics and thresholds and output progressive frames. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/freeverb/gstfreeverb.c b/gst/freeverb/gstfreeverb.c index 536452e81..f7292e038 100644 --- a/gst/freeverb/gstfreeverb.c +++ b/gst/freeverb/gstfreeverb.c @@ -30,16 +30,16 @@ /** * SECTION:element-freeverb + * @title: freeverb * * Reverberation/room effect. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 audiotestsrc wave=saw ! freeverb ! autoaudiosink * gst-launch-1.0 filesrc location="melo1.ogg" ! decodebin ! audioconvert ! freeverb ! autoaudiosink * ]| - * </refsect2> + * */ /* FIXME: diff --git a/gst/gaudieffects/gstburn.c b/gst/gaudieffects/gstburn.c index ee4487584..bf662270a 100644 --- a/gst/gaudieffects/gstburn.c +++ b/gst/gaudieffects/gstburn.c @@ -46,15 +46,15 @@ /** * SECTION:element-burn + * @title: burn * * Burn adjusts the colors of a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! burn ! videoconvert ! autovideosink * ]| This pipeline shows the effect of burn on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstchromium.c b/gst/gaudieffects/gstchromium.c index 65ac5b50c..fb55aac25 100644 --- a/gst/gaudieffects/gstchromium.c +++ b/gst/gaudieffects/gstchromium.c @@ -46,15 +46,15 @@ /** * SECTION:element-chromium + * @title: chromium * * Chromium breaks the colors of a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! chromium ! videoconvert ! autovideosink * ]| This pipeline shows the effect of chromium on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstdilate.c b/gst/gaudieffects/gstdilate.c index 301135d3b..a21ab3d5a 100644 --- a/gst/gaudieffects/gstdilate.c +++ b/gst/gaudieffects/gstdilate.c @@ -46,15 +46,15 @@ /** * SECTION:element-dilate + * @title: dilate * * Dilate adjusts the colors of a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! dilate ! videoconvert ! autovideosink * ]| This pipeline shows the effect of dilate on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstdodge.c b/gst/gaudieffects/gstdodge.c index eb5019e71..86b5d9d02 100644 --- a/gst/gaudieffects/gstdodge.c +++ b/gst/gaudieffects/gstdodge.c @@ -46,15 +46,15 @@ /** * SECTION:element-dodge + * @title: dodge * * Dodge saturates the colors of a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! dodge ! videoconvert ! autovideosink * ]| This pipeline shows the effect of dodge on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstexclusion.c b/gst/gaudieffects/gstexclusion.c index 6ebe82526..62445bd06 100644 --- a/gst/gaudieffects/gstexclusion.c +++ b/gst/gaudieffects/gstexclusion.c @@ -46,15 +46,15 @@ /** * SECTION:element-exclusion + * @title: exclusion * * Exclusion saturates the colors of a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! exclusion ! videoconvert ! autovideosink * ]| This pipeline shows the effect of exclusion on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstgaussblur.c b/gst/gaudieffects/gstgaussblur.c index 9c1e0979b..ff5ca520e 100644 --- a/gst/gaudieffects/gstgaussblur.c +++ b/gst/gaudieffects/gstgaussblur.c @@ -47,15 +47,15 @@ /** * SECTION:element-gaussianblur + * @title: gaussianblur * * Gaussianblur blurs the video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! gaussianblur ! videoconvert ! autovideosink * ]| This pipeline shows the effect of gaussianblur on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gaudieffects/gstsolarize.c b/gst/gaudieffects/gstsolarize.c index 0710d0fd6..8fc9ff69e 100644 --- a/gst/gaudieffects/gstsolarize.c +++ b/gst/gaudieffects/gstsolarize.c @@ -46,15 +46,15 @@ /** * SECTION:element-solarize + * @title: solarize * * Solarize does a smart inverse in a video stream in realtime. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! solarize ! videoconvert ! autovideosink * ]| This pipeline shows the effect of solarize on a test stream - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gdp/dataprotocol.c b/gst/gdp/dataprotocol.c index d6534ba94..47b0f7b19 100644 --- a/gst/gdp/dataprotocol.c +++ b/gst/gdp/dataprotocol.c @@ -23,6 +23,7 @@ /** * SECTION:gstdataprotocol + * @title: GstDataProtocol * @short_description: Serialization of caps, buffers and events. * @see_also: #GstCaps, #GstEvent, #GstBuffer * diff --git a/gst/gdp/gstgdpdepay.c b/gst/gdp/gstgdpdepay.c index b7269bd68..4d2093870 100644 --- a/gst/gdp/gstgdpdepay.c +++ b/gst/gdp/gstgdpdepay.c @@ -19,17 +19,17 @@ /** * SECTION:element-gdpdepay + * @title: gdpdepay * @see_also: gdppay * * This element depayloads GStreamer Data Protocol buffers back to deserialized * buffers and events. * - * <refsect2> * |[ * gst-launch-1.0 -v -m filesrc location=test.gdp ! gdpdepay ! xvimagesink * ]| This pipeline plays back a serialized video stream as created in the * example for gdppay. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/gdp/gstgdppay.c b/gst/gdp/gstgdppay.c index 6b55895b0..3546dd86a 100644 --- a/gst/gdp/gstgdppay.c +++ b/gst/gdp/gstgdppay.c @@ -20,17 +20,17 @@ /** * SECTION:element-gdppay + * @title: gdppay * @see_also: gdpdepay * * This element payloads GStreamer buffers and events using the * GStreamer Data Protocol. * - * <refsect2> * |[ * gst-launch-1.0 -v -m videotestsrc num-buffers=50 ! gdppay ! filesink location=test.gdp * ]| This pipeline creates a serialized video stream that can be played back * with the example shown in gdpdepay. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstbulge.c b/gst/geometrictransform/gstbulge.c index 98a7849ba..01e850b12 100644 --- a/gst/geometrictransform/gstbulge.c +++ b/gst/geometrictransform/gstbulge.c @@ -43,17 +43,17 @@ /** * SECTION:element-bulge + * @title: bulge * @see_also: geometrictransform * * Bugle is a geometric image transform element. It adds a protuberance in the * center point. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! bulge ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstcircle.c b/gst/geometrictransform/gstcircle.c index da4f48b0d..b326fd00b 100644 --- a/gst/geometrictransform/gstcircle.c +++ b/gst/geometrictransform/gstcircle.c @@ -49,17 +49,17 @@ /** * SECTION:element-circle + * @title: circle * @see_also: geometrictransform * * Circle is a geometric image transform element. It warps the picture into an * arc shaped form. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! circle ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstdiffuse.c b/gst/geometrictransform/gstdiffuse.c index 03009c724..36e4e62a2 100644 --- a/gst/geometrictransform/gstdiffuse.c +++ b/gst/geometrictransform/gstdiffuse.c @@ -49,17 +49,17 @@ /** * SECTION:element-diffuse + * @title: diffuse * @see_also: geometrictransform * * Diffuse is a geometric image transform element. It diffuses the image by * moving its pixels in random directions. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! diffuse ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstfisheye.c b/gst/geometrictransform/gstfisheye.c index d08069c2c..7150e3844 100644 --- a/gst/geometrictransform/gstfisheye.c +++ b/gst/geometrictransform/gstfisheye.c @@ -43,17 +43,17 @@ /** * SECTION:element-fisheye + * @title: fisheye * @see_also: geometrictransform * * Fisheye is a geometric image transform element. It simulates a fisheye lens * by zooming on the center of the image and compressing the edges. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! fisheye ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstkaleidoscope.c b/gst/geometrictransform/gstkaleidoscope.c index bb1bdfcb8..00f988f72 100644 --- a/gst/geometrictransform/gstkaleidoscope.c +++ b/gst/geometrictransform/gstkaleidoscope.c @@ -49,17 +49,17 @@ /** * SECTION:element-kaleidoscope + * @title: kaleidoscope * @see_also: geometrictransform * * The kaleidscope element applies 'kaleidoscope' geometric transform to the * image. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! kaleidoscope ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstmarble.c b/gst/geometrictransform/gstmarble.c index 689845366..f508d2a51 100644 --- a/gst/geometrictransform/gstmarble.c +++ b/gst/geometrictransform/gstmarble.c @@ -49,17 +49,17 @@ /** * SECTION:element-marble + * @title: marble * @see_also: geometrictransform * * Marble is a geometric image transform element. It applies a marbling effect * to the image. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! marble ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstmirror.c b/gst/geometrictransform/gstmirror.c index df18234d4..31e0a69c1 100644 --- a/gst/geometrictransform/gstmirror.c +++ b/gst/geometrictransform/gstmirror.c @@ -43,17 +43,17 @@ /** * SECTION:element-mirror + * @title: mirror * @see_also: geometrictransform * * Mirror is a geometric transform element. It splits the image into two halves * and reflects one over each other. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! mirror ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstperspective.c b/gst/geometrictransform/gstperspective.c index bafa1fc5d..e4da32fca 100644 --- a/gst/geometrictransform/gstperspective.c +++ b/gst/geometrictransform/gstperspective.c @@ -49,16 +49,16 @@ /** * SECTION:element-perspective + * @title: perspective * @see_also: geometrictransform * * The perspective element applies a 2D perspective transform. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! perspective ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ /* FIXME: suppress warnings for deprecated API such as GValueArray diff --git a/gst/geometrictransform/gstpinch.c b/gst/geometrictransform/gstpinch.c index d68dcd168..798b96586 100644 --- a/gst/geometrictransform/gstpinch.c +++ b/gst/geometrictransform/gstpinch.c @@ -49,16 +49,16 @@ /** * SECTION:element-pinch + * @title: pinch * @see_also: geometrictransform * * Pinch applies a 'pinch' geometric transform to the image. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! pinch ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstrotate.c b/gst/geometrictransform/gstrotate.c index 1e03339bf..d6f65152b 100644 --- a/gst/geometrictransform/gstrotate.c +++ b/gst/geometrictransform/gstrotate.c @@ -49,16 +49,16 @@ /** * SECTION:element-rotate + * @title: rotate * @see_also: geometrictransform * * The rotate element transforms the image by rotating it by a specified angle. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! rotate angle=0.78 ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstsphere.c b/gst/geometrictransform/gstsphere.c index 5f39a4765..90947a865 100644 --- a/gst/geometrictransform/gstsphere.c +++ b/gst/geometrictransform/gstsphere.c @@ -49,16 +49,16 @@ /** * SECTION:element-sphere + * @title: sphere * @see_also: geometrictransform * * The sphere element applies a 'sphere' geometric transform to the image. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! sphere ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstsquare.c b/gst/geometrictransform/gstsquare.c index 4b044f194..14271bd1e 100644 --- a/gst/geometrictransform/gstsquare.c +++ b/gst/geometrictransform/gstsquare.c @@ -43,16 +43,16 @@ /** * SECTION:element-square + * @title: square * @see_also: geometrictransform * * The square element distorts the center part of the image into a square. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! square zoom=100 ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gststretch.c b/gst/geometrictransform/gststretch.c index 61eed37f0..114a0cd22 100644 --- a/gst/geometrictransform/gststretch.c +++ b/gst/geometrictransform/gststretch.c @@ -43,16 +43,16 @@ /** * SECTION:element-stretch + * @title: stretch * @see_also: geometrictransform * * The stretch element stretches the image in a circle around the center point. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! stretch ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gsttunnel.c b/gst/geometrictransform/gsttunnel.c index 94b6070cc..8668a5282 100644 --- a/gst/geometrictransform/gsttunnel.c +++ b/gst/geometrictransform/gsttunnel.c @@ -43,17 +43,17 @@ /** * SECTION:element-tunnel + * @title: tunnel * @see_also: geometrictransform * * Tunnel is a geometric image transform element. It applies a light tunnel * effect. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! tunnel ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gsttwirl.c b/gst/geometrictransform/gsttwirl.c index 962d3ba6d..54ec46b9c 100644 --- a/gst/geometrictransform/gsttwirl.c +++ b/gst/geometrictransform/gsttwirl.c @@ -49,16 +49,16 @@ /** * SECTION:element-twirl + * @title: twirl * @see_also: geometrictransform * * The twirl element twists the image from the center out. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! twirl ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/geometrictransform/gstwaterripple.c b/gst/geometrictransform/gstwaterripple.c index 96af6e8d7..2d39df9db 100644 --- a/gst/geometrictransform/gstwaterripple.c +++ b/gst/geometrictransform/gstwaterripple.c @@ -49,16 +49,16 @@ /** * SECTION:element-waterripple + * @title: waterripple * @see_also: geometrictransform * * The waterripple element creates a water ripple effect on the image. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! waterripple ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/id3tag/gstid3mux.c b/gst/id3tag/gstid3mux.c index 37c7a4908..ccb23f91a 100644 --- a/gst/id3tag/gstid3mux.c +++ b/gst/id3tag/gstid3mux.c @@ -22,6 +22,7 @@ /** * SECTION:element-id3mux + * @title: id3mux * @see_also: #GstID3Demux, #GstTagSetter * * This element adds ID3v2 tags to the beginning of a stream, and ID3v1 tags @@ -34,8 +35,7 @@ * Tags sent by upstream elements will be picked up automatically (and merged * according to the merge mode set via the tag setter interface). * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v filesrc location=foo.ogg ! decodebin ! audioconvert ! id3mux ! filesink location=foo.mp3 * ]| A pipeline that transcodes a file from Ogg/Vorbis to mp3 format with @@ -44,7 +44,7 @@ * |[ * gst-launch-1.0 -m filesrc location=foo.mp3 ! id3demux ! fakesink silent=TRUE * ]| Verify that tags have been written. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstinteraudiosink.c b/gst/inter/gstinteraudiosink.c index 19fc5d2e3..3c3063103 100644 --- a/gst/inter/gstinteraudiosink.c +++ b/gst/inter/gstinteraudiosink.c @@ -18,13 +18,13 @@ */ /** * SECTION:element-gstinteraudiosink + * @title: gstinteraudiosink * * The interaudiosink element is an audio sink element. It is used * in connection with a interaudiosrc element in a different pipeline, * similar to intervideosink and intervideosrc. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v audiotestsrc ! queue ! interaudiosink * ]| @@ -34,7 +34,7 @@ * audio. * See the gstintertest.c example in the gst-plugins-bad source code for * more details. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstinteraudiosrc.c b/gst/inter/gstinteraudiosrc.c index 10581ba0d..886632e26 100644 --- a/gst/inter/gstinteraudiosrc.c +++ b/gst/inter/gstinteraudiosrc.c @@ -18,21 +18,21 @@ */ /** * SECTION:element-gstinteraudiosrc + * @title: gstinteraudiosrc * * The interaudiosrc element is an audio source element. It is used * in connection with a interaudiosink element in a different pipeline. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v interaudiosrc ! queue ! autoaudiosink * ]| - * + * * The interaudiosrc element cannot be used effectively with gst-launch-1.0, * as it requires a second pipeline in the application to send audio. * See the gstintertest.c example in the gst-plugins-bad source code for * more details. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstintersubsink.c b/gst/inter/gstintersubsink.c index 038acbbd0..62a627491 100644 --- a/gst/inter/gstintersubsink.c +++ b/gst/inter/gstintersubsink.c @@ -18,21 +18,21 @@ */ /** * SECTION:element-gstintersubsink + * @title: gstintersubsink * * The intersubsink element is a subtitle sink element. It is used * in connection with a intersubsrc element in a different pipeline. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v ... ! intersubsink * ]| - * + * * The intersubsink element cannot be used effectively with gst-launch-1.0, * as it requires a second pipeline in the application to send audio. * See the gstintertest.c example in the gst-plugins-bad source code for * more details. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstintersubsrc.c b/gst/inter/gstintersubsrc.c index ac49265f7..2ca1a523a 100644 --- a/gst/inter/gstintersubsrc.c +++ b/gst/inter/gstintersubsrc.c @@ -18,22 +18,22 @@ */ /** * SECTION:element-gstintersubsrc + * @title: gstintersubsrc * * The intersubsrc element is a subtitle source element. It is used * in connection with a intersubsink element in a different pipeline, * similar to interaudiosink and interaudiosrc. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v intersubsrc ! kateenc ! oggmux ! filesink location=out.ogv * ]| - * + * * The intersubsrc element cannot be used effectively with gst-launch-1.0, * as it requires a second pipeline in the application to send subtitles. * See the gstintertest.c example in the gst-plugins-bad source code for * more details. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstintervideosink.c b/gst/inter/gstintervideosink.c index edee11d86..b73a554c2 100644 --- a/gst/inter/gstintervideosink.c +++ b/gst/inter/gstintervideosink.c @@ -18,22 +18,22 @@ */ /** * SECTION:element-gstintervideosink + * @title: gstintervideosink * * The intervideosink element is a video sink element. It is used * in connection with an intervideosrc element in a different pipeline, * similar to interaudiosink and interaudiosrc. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! intervideosink * ]| - * + * * The intervideosink element cannot be used effectively with gst-launch-1.0, * as it requires a second pipeline in the application to send video to. * See the gstintertest.c example in the gst-plugins-bad source code for * more details. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/inter/gstintervideosrc.c b/gst/inter/gstintervideosrc.c index fd41d5091..1c20b4219 100644 --- a/gst/inter/gstintervideosrc.c +++ b/gst/inter/gstintervideosrc.c @@ -18,20 +18,20 @@ */ /** * SECTION:element-gstintervideosrc + * @title: gstintervideosrc * * The intervideosrc element is a video source element. It is used * in connection with a intervideosink element in a different pipeline, * similar to interaudiosink and interaudiosrc. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v intervideosrc ! queue ! xvimagesink * ]| - * + * * The intersubsrc element cannot be used effectively with gst-launch-1.0, * as it requires a second pipeline in the application to send subtitles. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/interlace/gstinterlace.c b/gst/interlace/gstinterlace.c index bf140b551..e0ff1aa4b 100644 --- a/gst/interlace/gstinterlace.c +++ b/gst/interlace/gstinterlace.c @@ -19,14 +19,14 @@ */ /** * SECTION:element-interlace + * @title: interlace * * The interlace element takes a non-interlaced raw video stream as input, * creates fields out of each frame, then combines fields into interlaced * frames to output as an interlaced video stream. It can also produce * telecined streams from progressive input. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc pattern=ball ! interlace ! xvimagesink * ]| @@ -35,7 +35,7 @@ * |[ * gst-launch-1.0 -v filesrc location=/path/to/file ! decodebin ! videorate ! * videoscale ! video/x-raw,format=\(string\)I420,width=720,height=480, - * framerate=60000/1001,pixel-aspect-ratio=11/10 ! + * framerate=60000/1001,pixel-aspect-ratio=11/10 ! * interlace top-field-first=false ! autovideosink * ]| * This pipeline converts a progressive video stream into an interlaced @@ -49,7 +49,7 @@ * This pipeline converts a 24 frames per second progressive film stream into a * 30000/1001 2:3:2:3... pattern telecined stream suitable for displaying film * content on NTSC. - * </refsect2> + * */ diff --git a/gst/ivtc/gstcombdetect.c b/gst/ivtc/gstcombdetect.c index 210d39cca..d55ab5b7c 100644 --- a/gst/ivtc/gstcombdetect.c +++ b/gst/ivtc/gstcombdetect.c @@ -18,18 +18,18 @@ */ /** * SECTION:element-gstcombdetect + * @title: gstcombdetect * * The combdetect element detects if combing artifacts are present in * a raw video stream, and if so, marks them with a zebra stripe * pattern. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=file.mov ! decodebin ! combdetect ! * xvimagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/ivtc/gstivtc.c b/gst/ivtc/gstivtc.c index 09b02a559..407fb2f30 100644 --- a/gst/ivtc/gstivtc.c +++ b/gst/ivtc/gstivtc.c @@ -19,13 +19,13 @@ */ /** * SECTION:element-gstivtc + * @title: gstivtc * * The ivtc element is an inverse telecine filter. It takes interlaced * video that was created from progressive content using a telecine * filter, and reconstructs the original progressive content. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc pattern=ball ! video/x-raw,framerate=24/1 ! * interlace ! @@ -36,7 +36,7 @@ * converts it to a 60 fields per second interlaced stream. Then the * stream is inversed telecine'd back to 24 fps, yielding approximately * the original videotestsrc content. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/jp2kdecimator/gstjp2kdecimator.c b/gst/jp2kdecimator/gstjp2kdecimator.c index 75ee74605..35c506cc9 100644 --- a/gst/jp2kdecimator/gstjp2kdecimator.c +++ b/gst/jp2kdecimator/gstjp2kdecimator.c @@ -19,11 +19,11 @@ */ /** * SECTION:element-gstjp2kdecimator + * @title: gstjp2kdecimator * * The jp2kdecimator element removes information from JPEG2000 images without reencoding. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc num-buffers=1 ! jp2kenc ! \ * gstjp2kdecimator max-decomposition-levels=2 ! jp2kdec ! \ @@ -31,7 +31,7 @@ * ]| * This pipelines encodes a test image to JPEG2000, only keeps 3 decomposition levels * decodes the decimated image again and shows it on the screen. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/jpegformat/gstjifmux.c b/gst/jpegformat/gstjifmux.c index b1ba175ec..517c994ec 100644 --- a/gst/jpegformat/gstjifmux.c +++ b/gst/jpegformat/gstjifmux.c @@ -22,20 +22,20 @@ /** * SECTION:element-jifmux + * @title: jifmux * @short_description: JPEG interchange format writer * * Writes a JPEG image as JPEG/EXIF or JPEG/JFIF including various metadata. The * jpeg image received on the sink pad should be minimal (e.g. should not * contain metadata already). * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc num-buffers=1 ! jpegenc ! jifmux ! filesink location=... * ]| * The above pipeline renders a frame, encodes to jpeg, adds metadata and writes * it to disk. - * </refsect2> + * */ /* jpeg interchange format: diff --git a/gst/jpegformat/gstjpegparse.c b/gst/jpegformat/gstjpegparse.c index 6978b57cf..dd684d79f 100644 --- a/gst/jpegformat/gstjpegparse.c +++ b/gst/jpegformat/gstjpegparse.c @@ -23,6 +23,7 @@ /** * SECTION:element-jpegparse + * @title: jpegparse * @short_description: JPEG parser * * Parses a JPEG stream into JPEG images. It looks for EOI boundaries to @@ -30,14 +31,13 @@ * image header searching for image properties such as width and height * among others. Jpegparse can also extract metadata (e.g. xmp). * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v souphttpsrc location=... ! jpegparse ! matroskamux ! filesink location=... * ]| * The above pipeline fetches a motion JPEG stream from an IP camera over * HTTP and stores it in a matroska file. - * </refsect2> + * */ /* FIXME: output plain JFIF APP marker only. This provides best code reuse. * JPEG decoders would not need to handle this part anymore. Also when remuxing diff --git a/gst/midi/midiparse.c b/gst/midi/midiparse.c index d58ea3f49..dc3c078ad 100644 --- a/gst/midi/midiparse.c +++ b/gst/midi/midiparse.c @@ -21,18 +21,18 @@ /** * SECTION:element-midiparse + * @title: midiparse * @see_also: fluiddec * * This element parses midi-files into midi events. You would need a midi * renderer such as fluidsynth to convert the events into raw samples. * - * <refsect2> - * <title>Example pipeline</title> + * ## Example pipeline * |[ * gst-launch-1.0 filesrc location=song.mid ! midiparse ! fluiddec ! pulsesink * ]| This example pipeline will parse the midi and render to raw audio which is * played via pulseaudio. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/mxf/mxfdemux.c b/gst/mxf/mxfdemux.c index 54ceec1df..5c176ac0e 100644 --- a/gst/mxf/mxfdemux.c +++ b/gst/mxf/mxfdemux.c @@ -19,15 +19,15 @@ /** * SECTION:element-mxfdemux + * @title: mxfdemux * * mxfdemux demuxes an MXF file into the different contained streams. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=/path/to/mxf ! mxfdemux ! audioconvert ! autoaudiosink * ]| This pipeline demuxes an MXF file and outputs one of the contained raw audio streams. - * </refsect2> + * */ /* TODO: diff --git a/gst/mxf/mxfmux.c b/gst/mxf/mxfmux.c index 7de12ac7a..4f6632107 100644 --- a/gst/mxf/mxfmux.c +++ b/gst/mxf/mxfmux.c @@ -19,15 +19,15 @@ /** * SECTION:element-mxfmux + * @title: mxfmux * * mxfmux muxes different streams into an MXF file. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=/path/to/audio ! decodebin ! queue ! mxfmux name=m ! filesink location=file.mxf filesrc location=/path/to/video ! decodebin ! queue ! m. * ]| This pipeline muxes an audio and video file into a single MXF file. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/pcapparse/gstirtspparse.c b/gst/pcapparse/gstirtspparse.c index f6b7aceea..a1d5989ff 100644 --- a/gst/pcapparse/gstirtspparse.c +++ b/gst/pcapparse/gstirtspparse.c @@ -20,6 +20,7 @@ */ /** * SECTION:element-irtspparse + * @title: irtspparse * @short_description: Interleaved RTSP parser * @see_also: #GstPcapParse * @@ -27,14 +28,13 @@ * so-called "channels" from received interleaved (TCP) RTSP data * (typically extracted from some network capture). * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 filesrc location=h264crasher.pcap ! pcapparse ! irtspparse * ! rtph264depay ! ffdec_h264 ! fakesink * ]| Read from a pcap dump file using filesrc, extract the raw TCP packets, * depayload and decode them. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/pcapparse/gstpcapparse.c b/gst/pcapparse/gstpcapparse.c index 4ffa8c1ac..6bd293a75 100644 --- a/gst/pcapparse/gstpcapparse.c +++ b/gst/pcapparse/gstpcapparse.c @@ -19,20 +19,20 @@ /** * SECTION:element-pcapparse + * @title: pcapparse * * Extracts payloads from Ethernet-encapsulated IP packets. * Use #GstPcapParse:src-ip, #GstPcapParse:dst-ip, * #GstPcapParse:src-port and #GstPcapParse:dst-port to restrict which packets * should be included. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 filesrc location=h264crasher.pcap ! pcapparse ! rtph264depay * ! ffdec_h264 ! fakesink * ]| Read from a pcap dump file using filesrc, extract the raw UDP packets, * depayload and decode them. - * </refsect2> + * */ /* TODO: diff --git a/gst/pnm/gstpnmdec.c b/gst/pnm/gstpnmdec.c index 1b5ea5117..5b624bed4 100644 --- a/gst/pnm/gstpnmdec.c +++ b/gst/pnm/gstpnmdec.c @@ -19,15 +19,15 @@ /** * SECTION:element-pnmdec + * @title: pnmdec * * Decodes pnm images. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 filesrc location=test.pnm ! pnmdec ! videoconvert ! autovideosink * ]| The above pipeline reads a pnm file and renders it to the screen. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/pnm/gstpnmenc.c b/gst/pnm/gstpnmenc.c index 2c45191cd..267384733 100644 --- a/gst/pnm/gstpnmenc.c +++ b/gst/pnm/gstpnmenc.c @@ -19,17 +19,17 @@ /** * SECTION:element-pnmenc + * @title: pnmenc * * Encodes pnm images. This plugin supports both raw and ASCII encoding. * To enable ASCII encoding, set the parameter ascii to TRUE. If you omit * the parameter or set it to FALSE, the output will be raw encoded. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc num_buffers=1 ! videoconvert ! "video/x-raw,format=GRAY8" ! pnmenc ascii=true ! filesink location=test.pnm * ]| The above pipeline writes a test pnm file (ASCII encoding). - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/rawparse/gstaudioparse.c b/gst/rawparse/gstaudioparse.c index 27884fd1c..e542d46d1 100644 --- a/gst/rawparse/gstaudioparse.c +++ b/gst/rawparse/gstaudioparse.c @@ -20,10 +20,11 @@ */ /** * SECTION:element-audioparse + * @title: audioparse * * Converts a byte stream into audio frames. * - * <note>This element is deprecated. Use #GstRawAudioParse instead.</note> + * This element is deprecated. Use #GstRawAudioParse instead. */ #ifdef HAVE_CONFIG_H diff --git a/gst/rawparse/gstvideoparse.c b/gst/rawparse/gstvideoparse.c index 9f5b19545..3a51ba1ce 100644 --- a/gst/rawparse/gstvideoparse.c +++ b/gst/rawparse/gstvideoparse.c @@ -21,10 +21,11 @@ */ /** * SECTION:element-videoparse + * @title: videoparse * * Converts a byte stream into video frames. * - * <note>This element is deprecated. Use #GstRawVideoParse instead.</note> + * > This element is deprecated. Use #GstRawVideoParse instead. */ #ifdef HAVE_CONFIG_H diff --git a/gst/removesilence/gstremovesilence.c b/gst/removesilence/gstremovesilence.c index 98456ff5c..3af56958e 100644 --- a/gst/removesilence/gstremovesilence.c +++ b/gst/removesilence/gstremovesilence.c @@ -20,15 +20,15 @@ /** * SECTION:element-removesilence + * @title: removesilence * * Removes all silence periods from an audio stream, dropping silence buffers. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v -m filesrc location="audiofile" ! decodebin ! removesilence remove=true ! wavenc ! filesink location=without_audio.wav * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/sdp/gstsdpdemux.c b/gst/sdp/gstsdpdemux.c index 6e176c0d2..4fc316d99 100644 --- a/gst/sdp/gstsdpdemux.c +++ b/gst/sdp/gstsdpdemux.c @@ -18,27 +18,27 @@ */ /** * SECTION:element-sdpdemux + * @title: sdpdemux * * sdpdemux currently understands SDP as the input format of the session description. * For each stream listed in the SDP a new stream_\%u pad will be created * with caps derived from the SDP media description. This is a caps of mime type * "application/x-rtp" that can be connected to any available RTP depayloader - * element. - * + * element. + * * sdpdemux will internally instantiate an RTP session manager element * that will handle the RTCP messages to and from the server, jitter removal, - * packet reordering along with providing a clock for the pipeline. - * - * sdpdemux acts like a live element and will therefore only generate data in the + * packet reordering along with providing a clock for the pipeline. + * + * sdpdemux acts like a live element and will therefore only generate data in the * PLAYING state. - * - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * gst-launch-1.0 souphttpsrc location=http://some.server/session.sdp ! sdpdemux ! fakesink * ]| Establish a connection to an HTTP server that contains an SDP session description * that gets parsed by sdpdemux and send the raw RTP packets to a fakesink. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/siren/gstsirendec.c b/gst/siren/gstsirendec.c index 78338ae2b..045bcd668 100644 --- a/gst/siren/gstsirendec.c +++ b/gst/siren/gstsirendec.c @@ -21,6 +21,7 @@ */ /** * SECTION:element-sirendec + * @title: sirendec * * This decodes audio buffers from the Siren 16 codec (a 16khz extension of * G.722.1) that is meant to be compatible with the Microsoft Windows Live diff --git a/gst/siren/gstsirenenc.c b/gst/siren/gstsirenenc.c index 0be5cd370..b54f29c5e 100644 --- a/gst/siren/gstsirenenc.c +++ b/gst/siren/gstsirenenc.c @@ -21,6 +21,7 @@ */ /** * SECTION:element-sirenenc + * @title: sirenenc * * This encodes audio buffers into the Siren 16 codec (a 16khz extension of * G.722.1) that is meant to be compatible with the Microsoft Windows Live diff --git a/gst/speed/gstspeed.c b/gst/speed/gstspeed.c index 7518de28a..8d90518a8 100644 --- a/gst/speed/gstspeed.c +++ b/gst/speed/gstspeed.c @@ -20,20 +20,20 @@ /** * SECTION:element-speed + * @title: speed * * Plays an audio stream at a different speed (by resampling the audio). - * + * * Do not use this element. Either use the 'pitch' element, or do a seek with * a non-1.0 rate parameter, this will have the same effect as using the speed * element (but relies on the decoder/demuxer to handle this correctly, also * requires a fairly up-to-date gst-plugins-base, as of February 2007). - * - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * gst-launch-1.0 filesrc location=test.ogg ! decodebin ! audioconvert ! speed speed=1.5 ! audioconvert ! audioresample ! autoaudiosink * ]| Plays an .ogg file at 1.5x speed. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/stereo/gststereo.c b/gst/stereo/gststereo.c index 35990104a..72539d6e1 100644 --- a/gst/stereo/gststereo.c +++ b/gst/stereo/gststereo.c @@ -23,15 +23,15 @@ */ /** * SECTION:element-stereo + * @title: stereo * * Create a wide stereo effect. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v filesrc location=sine.ogg ! oggdemux ! vorbisdec ! audioconvert ! stereo ! audioconvert ! audioresample ! alsasink * ]| Play an Ogg/Vorbis file. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/timecode/gstavwait.c b/gst/timecode/gstavwait.c index 780ee80df..9ee73ed57 100644 --- a/gst/timecode/gstavwait.c +++ b/gst/timecode/gstavwait.c @@ -23,6 +23,7 @@ /** * SECTION:element-avwait + * @title: avwait * * This element will drop all buffers until a specific timecode or running * time has been reached. It will then pass-through both audio and video, @@ -31,11 +32,10 @@ * the video). In the "audio-after-video" mode, it only drops audio buffers * until video has started. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 filesrc location="my_file" ! decodebin name=d ! "audio/x-raw" ! avwait name=l target-timecode-str="00:00:04:00" ! autoaudiosink d. ! "video/x-raw" ! timecodestamper ! l. l. ! queue ! timeoverlay time-mode=time-code ! autovideosink - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/timecode/gsttimecodestamper.c b/gst/timecode/gsttimecodestamper.c index 81860d0dc..b3c513ca0 100644 --- a/gst/timecode/gsttimecodestamper.c +++ b/gst/timecode/gsttimecodestamper.c @@ -22,18 +22,18 @@ /** * SECTION:element-timecodestamper + * @title: timecodestamper * @short_description: Attach a timecode into incoming video frames * * This element attaches a timecode into every incoming video frame. It starts * counting from the stream time of each segment start, which it converts into * a timecode. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! timecodestamper ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videofilters/gstscenechange.c b/gst/videofilters/gstscenechange.c index 5adf3ce40..4fef2ac2a 100644 --- a/gst/videofilters/gstscenechange.c +++ b/gst/videofilters/gstscenechange.c @@ -18,6 +18,7 @@ */ /** * SECTION:element-gstscenechange + * @title: gstscenechange * * The scenechange element detects scene changes (also known as shot * changes) in a video stream, and sends a signal when this occurs. @@ -32,13 +33,12 @@ * * The scenechange element does not work with compressed video. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=some_file.ogv ! decodebin ! * scenechange ! theoraenc ! fakesink * ]| - * </refsect2> + * */ /* * The algorithm used for scene change detection is a modification diff --git a/gst/videofilters/gstvideodiff.c b/gst/videofilters/gstvideodiff.c index 457ebd1d8..1181ad3c3 100644 --- a/gst/videofilters/gstvideodiff.c +++ b/gst/videofilters/gstvideodiff.c @@ -18,16 +18,16 @@ */ /** * SECTION:element-gstvideodiff + * @title: gstvideodiff * * The videodiff element highlights the difference between a frame and its * previous on the luma plane. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc pattern=ball ! videodiff ! videoconvert ! autovideosink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videofilters/gstzebrastripe.c b/gst/videofilters/gstzebrastripe.c index 81f58b874..983f02d52 100644 --- a/gst/videofilters/gstzebrastripe.c +++ b/gst/videofilters/gstzebrastripe.c @@ -18,6 +18,7 @@ */ /** * SECTION:element-gstzebrastripe + * @title: gstzebrastripe * * The zebrastripe element marks areas of images in a video stream * that are brighter than a threshold with a diagonal zebra stripe @@ -27,8 +28,7 @@ * threshold setting of 70 is often used to properly adjust skin * tones. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc ! zebrastripe ! xvimagesink * ]| @@ -39,7 +39,7 @@ * property setting can be calculated from IRE by using the formula * percent = (IRE * 1.075) - 7.5. Note that 100 IRE corresponds to * 100 %, and 70 IRE corresponds to 68 %. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videoframe_audiolevel/gstvideoframe-audiolevel.c b/gst/videoframe_audiolevel/gstvideoframe-audiolevel.c index 46fda779e..bd5b43db5 100644 --- a/gst/videoframe_audiolevel/gstvideoframe-audiolevel.c +++ b/gst/videoframe_audiolevel/gstvideoframe-audiolevel.c @@ -24,16 +24,16 @@ /** * SECTION:element-videoframe-audiolevel + * @title: videoframe-audiolevel * * This element acts like a synchronized audio/video "level". It gathers * all audio buffers sent between two video frames, and then sends a message * that contains the RMS value of all samples for these buffers. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -m filesrc location="file.mkv" ! decodebin name=d ! "audio/x-raw" ! videoframe-audiolevel name=l ! autoaudiosink d. ! "video/x-raw" ! l. l. ! queue ! autovideosink ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videoparsers/gstdiracparse.c b/gst/videoparsers/gstdiracparse.c index c674cb835..219f584a7 100644 --- a/gst/videoparsers/gstdiracparse.c +++ b/gst/videoparsers/gstdiracparse.c @@ -18,16 +18,16 @@ */ /** * SECTION:element-gstdiracparse + * @title: gstdiracparse * * The gstdiracparse element does FIXME stuff. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v fakesrc ! gstdiracparse ! FIXME ! fakesink * ]| * FIXME Describe what the pipeline does. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videosignal/gstsimplevideomark.c b/gst/videosignal/gstsimplevideomark.c index 2a527c32e..ae4d0c02a 100644 --- a/gst/videosignal/gstsimplevideomark.c +++ b/gst/videosignal/gstsimplevideomark.c @@ -18,27 +18,27 @@ */ /** * SECTION:element-simplevideomark + * @title: simplevideomark * @see_also: #GstVideoDetect * * This plugin produces #GstSimpleVideoMark::pattern-count squares in the bottom left - * corner of the video frames. The squares have a width and height of + * corner of the video frames. The squares have a width and height of * respectively #GstSimpleVideoMark:pattern-width and #GstSimpleVideoMark:pattern-height. * Even squares will be black and odd squares will be white. - * + * * After writing the pattern, #GstSimpleVideoMark:pattern-data-count squares after the * pattern squares are produced as the bitarray given in * #GstSimpleVideoMark:pattern-data. 1 bits will produce white squares and 0 bits will * produce black squares. - * + * * The element can be enabled with the #GstSimpleVideoMark:enabled property. It is * mostly used together with the #GstVideoDetect plugin. - * - * <refsect2> - * <title>Example launch line</title> + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! simplevideomark ! videoconvert ! ximagesink * ]| Add the default black/white squares at the bottom left of the video frames. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videosignal/gstsimplevideomarkdetect.c b/gst/videosignal/gstsimplevideomarkdetect.c index 1e95c8155..d58cff2e2 100644 --- a/gst/videosignal/gstsimplevideomarkdetect.c +++ b/gst/videosignal/gstsimplevideomarkdetect.c @@ -18,78 +18,46 @@ */ /** * SECTION:element-simplevideomarkdetect + * @title: simplevideomarkdetect * @see_also: #GstVideoMark * * This plugin detects #GstSimpleVideoMarkDetect:pattern-count squares in the bottom left * corner of the video frames. The squares have a width and height of * respectively #GstSimpleVideoMarkDetect:pattern-width and #GstSimpleVideoMarkDetect:pattern-height. * Even squares must be black and odd squares must be white. - * + * * When the pattern has been found, #GstSimpleVideoMarkDetect:pattern-data-count squares * after the pattern squares are read as a bitarray. White squares represent a 1 * bit and black squares a 0 bit. The bitarray will will included in the element * message that is posted (see below). - * + * * After the pattern has been found and the data pattern has been read, an - * element message called <classname>"GstSimpleVideoMarkDetect"</classname> will + * 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. - * + * * The message's structure contains these fields: - * <itemizedlist> - * <listitem> - * <para> - * #gboolean - * <classname>"have-pattern"</classname>: - * 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. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"timestamp"</classname>: - * the timestamp of the buffer that triggered the message. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"stream-time"</classname>: - * the stream time of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"running-time"</classname>: - * the running_time of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"duration"</classname>: - * the duration of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #guint64 - * <classname>"data"</classname>: - * the data-pattern found after the pattern or 0 when have-signal is #FALSE. - * </para> - * </listitem> - * </itemizedlist> - * - * <refsect2> - * <title>Example launch line</title> + * + * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message. + * + * * #GstClockTime `stream-time`: the stream time of the buffer. + * + * * #GstClockTime `running-time`: the running_time of the buffer. + * + * * #GstClockTime `duration`: the duration of the buffer. + * + * * #guint64 `data`: the data-pattern found after the pattern or 0 when have-signal is #FALSE. + * + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! simplevideomarkdetect ! videoconvert ! ximagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/videosignal/gstvideoanalyse.c b/gst/videosignal/gstvideoanalyse.c index ea52bdf7d..2723c14fd 100644 --- a/gst/videosignal/gstvideoanalyse.c +++ b/gst/videosignal/gstvideoanalyse.c @@ -18,63 +18,31 @@ */ /** * SECTION:element-videoanalyse + * @title: videoanalyse * * This plugin analyses every video frame and if the #GstVideoAnalyse:message * property is #TRUE, posts an element message with video statistics called - * <classname>"GstVideoAnalyse"</classname>. + * `GstVideoAnalyse`. * * The message's structure contains these fields: - * <itemizedlist> - * <listitem> - * <para> - * #GstClockTime - * <classname>"timestamp"</classname>: - * the timestamp of the buffer that triggered the message. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"stream-time"</classname>: - * the stream time of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"running-time"</classname>: - * the running_time of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #GstClockTime - * <classname>"duration"</classname>: - * the duration of the buffer. - * </para> - * </listitem> - * <listitem> - * <para> - * #gdouble - * <classname>"luma-average"</classname>: - * the average brightness of the frame. Range: 0.0-1.0 - * </para> - * </listitem> - * <listitem> - * <para> - * #gdouble - * <classname>"luma-variance"</classname>: - * the brightness variance of the frame. - * </para> - * </listitem> - * </itemizedlist> - * - * <refsect2> - * <title>Example launch line</title> + * + * * #GstClockTime `timestamp`: the timestamp of the buffer that triggered the message. + * + * * #GstClockTime `stream-time`: the stream time of the buffer. + * + * * #GstClockTime `running-time`: the running_time of the buffer. + * + * * #GstClockTime`duration`:the duration of the buffer. + * + * * #gdouble`luma-average`: the average brightness of the frame. Range: 0.0-1.0 + * + * * #gdouble`luma-variance`: the brightness variance of the frame. + * + * ## Example launch line * |[ * gst-launch-1.0 -m videotestsrc ! videoanalyse ! videoconvert ! ximagesink - * ]| This pipeline emits messages to the console for each frame that has been analysed. - * </refsect2> + * ]| This pipeline emits messages to the console for each frame that has been analysed. + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/y4m/gsty4mdec.c b/gst/y4m/gsty4mdec.c index 30966b0cc..687138154 100644 --- a/gst/y4m/gsty4mdec.c +++ b/gst/y4m/gsty4mdec.c @@ -18,15 +18,15 @@ */ /** * SECTION:element-gsty4mdec + * @title: gsty4mdec * * The gsty4mdec element decodes uncompressed video in YUV4MPEG format. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=file.y4m ! y4mdec ! xvimagesink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/gst/yadif/gstyadif.c b/gst/yadif/gstyadif.c index 2611c644f..0056f7845 100644 --- a/gst/yadif/gstyadif.c +++ b/gst/yadif/gstyadif.c @@ -18,7 +18,8 @@ * Boston, MA 02110-1335, USA. */ /** - * SECTION:element-gstyadif + * SECTION:element-yadif + * @title: yadif * * The yadif element deinterlaces video, using the YADIF deinterlacing * filter copied from Libav. This element only handles the simple case @@ -26,14 +27,13 @@ * inverse telecine and deinterlace cases that are handled by the * deinterlace element. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v videotestsrc pattern=ball ! interlace ! yadif ! xvimagesink * ]| * This pipeline creates an interlaced test pattern, and then deinterlaces * it using the yadif filter. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H |