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 /sys | |
parent | 90f766cc518b4fde651162d6e0c7d190373e3c61 (diff) | |
download | gstreamer-plugins-bad-78022a6e0c05ce482b798cf638cbd3f901a5094e.tar.gz |
docs: Port all docstring to gtk-doc markdown
Diffstat (limited to 'sys')
-rw-r--r-- | sys/androidmedia/gstahcsrc.c | 31 | ||||
-rw-r--r-- | sys/androidmedia/gstahssrc.c | 8 | ||||
-rw-r--r-- | sys/applemedia/atdec.c | 8 | ||||
-rw-r--r-- | sys/applemedia/vtdec.c | 8 | ||||
-rw-r--r-- | sys/d3dvideosink/d3dhelpers.c | 20 | ||||
-rw-r--r-- | sys/d3dvideosink/d3dvideosink.c | 10 | ||||
-rw-r--r-- | sys/directsound/gstdirectsoundsrc.c | 6 | ||||
-rw-r--r-- | sys/dvb/gstdvbsrc.c | 6 | ||||
-rw-r--r-- | sys/kms/gstkmssink.c | 6 | ||||
-rw-r--r-- | sys/opensles/openslessink.c | 5 | ||||
-rw-r--r-- | sys/opensles/openslessrc.c | 5 | ||||
-rw-r--r-- | sys/shm/gstshmsink.c | 6 | ||||
-rw-r--r-- | sys/shm/gstshmsrc.c | 6 | ||||
-rw-r--r-- | sys/tinyalsa/tinyalsasink.c | 6 | ||||
-rw-r--r-- | sys/uvch264/gstuvch264_mjpgdemux.c | 1 | ||||
-rw-r--r-- | sys/uvch264/gstuvch264_src.c | 1 | ||||
-rw-r--r-- | sys/vdpau/gstvdpsink.h | 2 | ||||
-rw-r--r-- | sys/vdpau/gstvdpvideomemory.c | 2 | ||||
-rw-r--r-- | sys/vdpau/gstvdpvideopostprocess.c | 6 | ||||
-rw-r--r-- | sys/wasapi/gstwasapisink.c | 6 | ||||
-rw-r--r-- | sys/wasapi/gstwasapisrc.c | 6 | ||||
-rw-r--r-- | sys/winks/gstksvideosrc.c | 6 | ||||
-rw-r--r-- | sys/winscreencap/gstdx9screencapsrc.c | 6 | ||||
-rw-r--r-- | sys/winscreencap/gstgdiscreencapsrc.c | 6 |
24 files changed, 85 insertions, 88 deletions
diff --git a/sys/androidmedia/gstahcsrc.c b/sys/androidmedia/gstahcsrc.c index 2fa1d6f24..cb23be2e8 100644 --- a/sys/androidmedia/gstahcsrc.c +++ b/sys/androidmedia/gstahcsrc.c @@ -21,6 +21,7 @@ /** * SECTION:element-ahcsrc + * @title: ahcsrc * * ahcsrc can be used to capture video from android devices. It uses the * android.hardware.Camera Java API to capture from the system's cameras. @@ -31,7 +32,7 @@ * so it can be loaded into the virtual machine. * In order for it to work, an environment variable must be set to a writable * directory. - * The source will look for the environment variable “TMP” which must contain + * The source will look for the environment variable “TMPâ€� which must contain * the absolute path to a writable directory. * It can be retreived using the following Java code : * |[ @@ -40,28 +41,24 @@ * Where the @context variable is an object of type android.content.Context * (including its subclasses android.app.Activity or android.app.Application). * Another optional environment variable can be set for pointing to the - * optimized dex classes directory. If the environment variable “DEX” is - * available, it will be used, otherwise, the directory in the “TMP” environment + * optimized dex classes directory. If the environment variable “DEXâ€� is + * available, it will be used, otherwise, the directory in the “TMPâ€� environment * variable will be used for the optimized dex directory. * The system dex directory can be obtained using the following Java code : * |[ - * context.getDir(“dex”, 0).getAbsolutePath(); + * context.getDir("dex", 0).getAbsolutePath(); * ]| * - * <note> - * Those environment variable must be set before gst_init is called from - * the native code. - * </note> + * > Those environment variable must be set before gst_init is called from + * > the native code. * - * <note> - * If the “TMP” environment variable is not available or the directory is not - * writable or any other issue happens while trying to load the embedded jar - * file, then the source will fallback on trying to load the class directly - * from the running application. - * The file com/gstreamer/GstAhcCallback.java in the source's directory can be - * copied into the Android application so it can be loaded at runtime - * as a fallback mechanism. - * </note> + * > If the "TMP" environment variable is not available or the directory is not + * > writable or any other issue happens while trying to load the embedded jar + * > file, then the source will fallback on trying to load the class directly + * > from the running application. + * > The file com/gstreamer/GstAhcCallback.java in the source's directory can be + * > copied into the Android application so it can be loaded at runtime + * > as a fallback mechanism. * */ diff --git a/sys/androidmedia/gstahssrc.c b/sys/androidmedia/gstahssrc.c index 88f8282d6..c71637833 100644 --- a/sys/androidmedia/gstahssrc.c +++ b/sys/androidmedia/gstahssrc.c @@ -18,18 +18,18 @@ * Boston, MA 02110-1301, USA. */ /** - * SECTION:element-gstahssrc + * SECTION:element-ahssrc + * @title: gstahssrc * * The ahssrc element reads data from Android device sensors * (android.hardware.Sensor). * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch -v ahssrc ! fakesink * ]| * Push Android sensor data into a fakesink. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/applemedia/atdec.c b/sys/applemedia/atdec.c index b14891fd8..a1a2369b7 100644 --- a/sys/applemedia/atdec.c +++ b/sys/applemedia/atdec.c @@ -17,17 +17,17 @@ * Boston, MA 02110-1335, USA. */ /** - * SECTION:element-gstatdec + * SECTION:element-atdec + * @title: atdec * * AudioToolbox based decoder. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=file.mov ! qtdemux ! queue ! aacparse ! atdec ! autoaudiosink * ]| * Decode aac audio from a mov file - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/applemedia/vtdec.c b/sys/applemedia/vtdec.c index 472e39eb4..d9c943d6a 100644 --- a/sys/applemedia/vtdec.c +++ b/sys/applemedia/vtdec.c @@ -18,17 +18,17 @@ * Boston, MA 02110-1335, USA. */ /** - * SECTION:element-gstvtdec + * SECTION:element-vtdec + * @title: gstvtdec * * Apple VideoToolbox based decoder. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v filesrc location=file.mov ! qtdemux ! queue ! h264parse ! vtdec ! videoconvert ! autovideosink * ]| * Decode h264 video from a mov file. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/d3dvideosink/d3dhelpers.c b/sys/d3dvideosink/d3dhelpers.c index 9f391a653..9e7f95aaf 100644 --- a/sys/d3dvideosink/d3dhelpers.c +++ b/sys/d3dvideosink/d3dhelpers.c @@ -36,7 +36,7 @@ typedef enum WINDOW_VISIBILITY_ERROR = 4 } WindowHandleVisibility; -/** FWD DECLS **/ +/* FWD DECLS */ static gboolean d3d_hidden_window_thread (GstD3DVideoSinkClass * klass); static gboolean d3d_window_wndproc_set (GstD3DVideoSink * sink); @@ -68,7 +68,7 @@ static gint WM_D3DVIDEO_NOTIFY_DEVICE_LOST = 0; #define WM_QUIT_THREAD WM_USER+0 -/** Helpers **/ +/* Helpers */ #define ERROR_CHECK_HR(hr) \ if(hr != S_OK) { \ @@ -119,7 +119,7 @@ static gint WM_D3DVIDEO_NOTIFY_DEVICE_LOST = 0; #define D3DFMT_NV12 MAKEFOURCC ('N', 'V', '1', '2') #endif -/** FORMATS **/ +/* FORMATS */ #define CASE(x) case x: return #x; static const gchar * @@ -978,7 +978,7 @@ end: return ret; } -/** Windows for rendering (User Set or Internal) **/ +/* Windows for rendering (User Set or Internal) */ static void d3d_window_wndproc_unset (GstD3DVideoSink * sink) @@ -1208,7 +1208,7 @@ d3d_stop (GstD3DVideoSink * sink) return TRUE; } -/** D3D Lost and Reset Device **/ +/* D3D Lost and Reset Device */ static void d3d_notify_device_lost (GstD3DVideoSink * sink) @@ -1256,7 +1256,7 @@ d3d_notify_device_reset (GstD3DVideoSink * sink) UNLOCK_SINK (sink); } -/** Swap Chains **/ +/* Swap Chains */ static gboolean d3d_init_swap_chain (GstD3DVideoSink * sink, HWND hWnd) @@ -1988,7 +1988,7 @@ end: } -/** D3D Window Proc Functions **/ +/* D3D Window Proc Functions */ static LRESULT APIENTRY d3d_wnd_proc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) @@ -2110,7 +2110,7 @@ end: return ret; } -/** Internal Window **/ +/* Internal Window */ static LRESULT APIENTRY d3d_wnd_proc_internal (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) @@ -2269,7 +2269,7 @@ d3d_create_internal_window (GstD3DVideoSink * sink) return dat.hWnd; } -/*** D3D Video Class Methdos ***/ +/* D3D Video Class Methdos */ gboolean d3d_class_init (GstD3DVideoSink * sink) @@ -2590,7 +2590,7 @@ end:; UNLOCK_CLASS (NULL, klass); } -/** Hidden Window Loop Thread **/ +/* Hidden Window Loop Thread */ static LRESULT APIENTRY D3DHiddenWndProc (HWND hWnd, UINT message, WPARAM wParam, LPARAM lParam) diff --git a/sys/d3dvideosink/d3dvideosink.c b/sys/d3dvideosink/d3dvideosink.c index 88e201edc..74920d78c 100644 --- a/sys/d3dvideosink/d3dvideosink.c +++ b/sys/d3dvideosink/d3dvideosink.c @@ -54,7 +54,7 @@ static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink", GST_DEBUG_CATEGORY (gst_d3dvideosink_debug); #define GST_CAT_DEFAULT gst_d3dvideosink_debug -/** FWD DECLS **/ +/* FWD DECLS */ /* GstXOverlay Interface */ static void gst_d3dvideosink_video_overlay_interface_init (GstVideoOverlayInterface * @@ -176,7 +176,7 @@ gst_d3dvideosink_init (GstD3DVideoSink * sink) g_rec_mutex_init (&sink->lock); } -/** GObject Functions **/ +/* GObject Functions */ static void gst_d3dvideosink_finalize (GObject * gobject) @@ -245,7 +245,7 @@ gst_d3dvideosink_get_property (GObject * object, guint prop_id, GValue * value, } } -/** GstBaseSinkClass Functions **/ +/* GstBaseSinkClass Functions */ static GstCaps * gst_d3dvideosink_get_caps (GstBaseSink * basesink, GstCaps * filter) @@ -525,7 +525,7 @@ gst_d3dvideosink_propose_allocation (GstBaseSink * bsink, GstQuery * query) return TRUE; } -/** PUBLIC FUNCTIONS **/ +/* PUBLIC FUNCTIONS */ /* Iterface Registrations */ @@ -602,7 +602,7 @@ gst_d3dvideosink_navigation_send_event (GstNavigation * navigation, } } -/** PRIVATE FUNCTIONS **/ +/* PRIVATE FUNCTIONS */ /* Plugin entry point */ diff --git a/sys/directsound/gstdirectsoundsrc.c b/sys/directsound/gstdirectsoundsrc.c index 397746641..e4f5b1a7f 100644 --- a/sys/directsound/gstdirectsoundsrc.c +++ b/sys/directsound/gstdirectsoundsrc.c @@ -50,15 +50,15 @@ /** * SECTION:element-directsoundsrc + * @title: directsoundsrc * * Reads audio data using the DirectSound API. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v directsoundsrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=dsound.ogg * ]| Record from DirectSound and encode to Ogg/Vorbis. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/dvb/gstdvbsrc.c b/sys/dvb/gstdvbsrc.c index da55bd2a9..7e3f1e2fa 100644 --- a/sys/dvb/gstdvbsrc.c +++ b/sys/dvb/gstdvbsrc.c @@ -21,12 +21,12 @@ */ /** * SECTION:element-dvbsrc + * @title: dvbsrc * * dvbsrc can be used to capture media from DVB cards. Supported DTV * broadcasting standards include DVB-T/C/S, ATSC, ISDB-T and DTMB. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 dvbsrc modulation="QAM 64" trans-mode=8k bandwidth=8 frequency=514000000 code-rate-lp=AUTO code-rate-hp=2/3 guard=4 hierarchy=0 ! mpegtsdemux name=demux ! queue max-size-buffers=0 max-size-time=0 ! mpegvideoparse ! mpegvideoparse ! mpeg2dec ! xvimagesink demux. ! queue max-size-buffers=0 max-size-time=0 ! mpegaudioparse ! mpg123audiodec ! audioconvert ! pulsesink * ]| Captures a full transport stream from DVB card 0 that is a DVB-T card at tuned frequency 514000000 Hz with other parameters as seen in the pipeline and renders the first TV program on the transport stream. @@ -42,7 +42,7 @@ * |[ * gst-launch-1.0 dvbsrc frequency=503000000 delsys="atsc" modulation="8vsb" pids=48:49:52 ! decodebin name=dec dec. ! videoconvert ! autovideosink dec. ! audioconvert ! autoaudiosink * ]| Captures and renders KOFY-HD in San Jose, California. This is an ATSC broadcast, PMT ID 48, Audio/Video elementary stream PIDs 49 and 52 respectively. - * </refsect2> + * */ /* diff --git a/sys/kms/gstkmssink.c b/sys/kms/gstkmssink.c index 82bb6391c..8a9ff365d 100644 --- a/sys/kms/gstkmssink.c +++ b/sys/kms/gstkmssink.c @@ -25,17 +25,17 @@ /** * SECTION:element-kmssink + * @title: kmssink * @short_description: A KMS/DRM based video sink * * kmssink is a simple video sink that renders video frames directly * in a plane of a DRM device. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 videotestsrc ! kmssink * ]| - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/opensles/openslessink.c b/sys/opensles/openslessink.c index 24938539a..c4c049208 100644 --- a/sys/opensles/openslessink.c +++ b/sys/opensles/openslessink.c @@ -19,16 +19,15 @@ /** * SECTION:element-openslessink + * @title: openslessink * @see_also: openslessrc * * This element renders raw audio samples using the OpenSL ES API in Android OS. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v filesrc location=music.ogg ! oggdemux ! vorbisdec ! audioconvert ! audioresample ! opeslessink * ]| Play an Ogg/Vorbis file. - * </refsect2> * */ diff --git a/sys/opensles/openslessrc.c b/sys/opensles/openslessrc.c index f32984ab1..66c3031df 100644 --- a/sys/opensles/openslessrc.c +++ b/sys/opensles/openslessrc.c @@ -19,16 +19,15 @@ /** * SECTION:element-openslessrc + * @title: openslessrc * @see_also: openslessink * * This element reads data from default audio input using the OpenSL ES API in Android OS. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v openslessrc ! audioconvert ! vorbisenc ! oggmux ! filesink location=recorded.ogg * ]| Record from default audio input and encode to Ogg/Vorbis. - * </refsect2> * */ diff --git a/sys/shm/gstshmsink.c b/sys/shm/gstshmsink.c index 8fcb9596a..b2e7dbeee 100644 --- a/sys/shm/gstshmsink.c +++ b/sys/shm/gstshmsink.c @@ -20,17 +20,17 @@ */ /** * SECTION:element-shmsink + * @title: shmsink * * Send data over shared memory to the matching source. * - * <refsect2> - * <title>Example launch lines</title> + * ## Example launch lines * |[ * gst-launch-1.0 -v videotestsrc ! "video/x-raw, format=YUY2, color-matrix=sdtv, \ * chroma-site=mpeg2, width=(int)320, height=(int)240, framerate=(fraction)30/1" \ * ! shmsink socket-path=/tmp/blah shm-size=2000000 * ]| Send video to shm buffers. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H #include "config.h" diff --git a/sys/shm/gstshmsrc.c b/sys/shm/gstshmsrc.c index 86955602a..068a34849 100644 --- a/sys/shm/gstshmsrc.c +++ b/sys/shm/gstshmsrc.c @@ -20,18 +20,18 @@ */ /** * SECTION:element-shmsrc + * @title: shmsrc * * Receive data from the shared memory sink. * - * <refsect2> - * <title>Example launch lines</title> + * ## Example launch lines * |[ * gst-launch-1.0 shmsrc socket-path=/tmp/blah ! \ * "video/x-raw, format=YUY2, color-matrix=sdtv, \ * chroma-site=mpeg2, width=(int)320, height=(int)240, framerate=(fraction)30/1" \ * ! queue ! videoconvert ! autovideosink * ]| Render video from shm buffers. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/tinyalsa/tinyalsasink.c b/sys/tinyalsa/tinyalsasink.c index 7c7799cea..7d6bf804b 100644 --- a/sys/tinyalsa/tinyalsasink.c +++ b/sys/tinyalsa/tinyalsasink.c @@ -20,18 +20,18 @@ /** * SECTION:element-tinyalsasink + * @title: tinyalsasink * @see_also: alsasink * * This element renders raw audio samples using the ALSA audio API via the * tinyalsa library. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v uridecodebin uri=file:///path/to/audio.ogg ! audioconvert ! audioresample ! tinyalsasink * ]| Play an Ogg/Vorbis file and output audio via ALSA using the tinyalsa * library. - * </refsect2> + * */ #include <gst/audio/gstaudiobasesink.h> diff --git a/sys/uvch264/gstuvch264_mjpgdemux.c b/sys/uvch264/gstuvch264_mjpgdemux.c index e253a0429..e90ac6fbe 100644 --- a/sys/uvch264/gstuvch264_mjpgdemux.c +++ b/sys/uvch264/gstuvch264_mjpgdemux.c @@ -23,6 +23,7 @@ /** * SECTION:element-uvch264mjpgdemux + * @title: uvch264mjpgdemux * @short_description: UVC H264 compliant MJPG demuxer * * Parses a MJPG stream from a UVC H264 compliant encoding camera and extracts diff --git a/sys/uvch264/gstuvch264_src.c b/sys/uvch264/gstuvch264_src.c index 4f2a6f304..00bbad691 100644 --- a/sys/uvch264/gstuvch264_src.c +++ b/sys/uvch264/gstuvch264_src.c @@ -23,6 +23,7 @@ /** * SECTION:element-uvch264-src + * @title: uvch264-src * * A camera bin src element that wraps v4l2src and implements UVC H264 * Extension Units (XU) to control the H264 encoder in the camera diff --git a/sys/vdpau/gstvdpsink.h b/sys/vdpau/gstvdpsink.h index e5e7e9405..04e3bd588 100644 --- a/sys/vdpau/gstvdpsink.h +++ b/sys/vdpau/gstvdpsink.h @@ -86,7 +86,7 @@ struct _GstVdpWindow { * @flow_lock: used to protect data flow routines from external calls such as * events from @event_thread or methods from the #GstXOverlay interface * @par: used to override calculated pixel aspect ratio from @xcontext - * @synchronous: used to store if XSynchronous should be used or not (for + * @synchronous: used to store if XSynchronous should be used or not (for * debugging purpose only) * @handle_events: used to know if we should handle select XEvents or not * diff --git a/sys/vdpau/gstvdpvideomemory.c b/sys/vdpau/gstvdpvideomemory.c index 8217653d2..92aff573a 100644 --- a/sys/vdpau/gstvdpvideomemory.c +++ b/sys/vdpau/gstvdpvideomemory.c @@ -231,7 +231,7 @@ _vdp_video_mem_free (GstAllocator * allocator, GstMemory * mem) * gst_vdp_video_memory_alloc: * @device: a #GstVdpDevice * @info: the #GstVideoInfo describing the format to use - * + * * Returns: a GstMemory object with a VdpVideoSurface specified by @info * from @device */ diff --git a/sys/vdpau/gstvdpvideopostprocess.c b/sys/vdpau/gstvdpvideopostprocess.c index 7f4f480a4..e2032f4f6 100644 --- a/sys/vdpau/gstvdpvideopostprocess.c +++ b/sys/vdpau/gstvdpvideopostprocess.c @@ -20,15 +20,15 @@ /** * SECTION:element-vdpauvideopostprocess + * @title: vdpauvideopostprocess * * FIXME:Describe vdpaumpegdec here. * - * <refsect2> - * <title>Example launch line</title> + * ## Example launch line * |[ * gst-launch-1.0 -v -m fakesrc ! vdpauvideopostprocess ! fakesink silent=TRUE * ]| - * </refsect2> + * */ /* diff --git a/sys/wasapi/gstwasapisink.c b/sys/wasapi/gstwasapisink.c index 5b35b8e1e..fac3cb1ba 100644 --- a/sys/wasapi/gstwasapisink.c +++ b/sys/wasapi/gstwasapisink.c @@ -21,16 +21,16 @@ /** * SECTION:element-wasapisink + * @title: wasapisink * * Provides audio playback using the Windows Audio Session API available with * Vista and newer. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v audiotestsrc samplesperbuffer=160 ! wasapisink * ]| Generate 20 ms buffers and render to the default audio device. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H # include <config.h> diff --git a/sys/wasapi/gstwasapisrc.c b/sys/wasapi/gstwasapisrc.c index 20c392964..0fdec2b8e 100644 --- a/sys/wasapi/gstwasapisrc.c +++ b/sys/wasapi/gstwasapisrc.c @@ -19,16 +19,16 @@ /** * SECTION:element-wasapisrc + * @title: wasapisrc * * Provides audio capture from the Windows Audio Session API available with * Vista and newer. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v wasapisrc ! fakesink * ]| Capture from the default audio device and render to fakesink. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H # include <config.h> diff --git a/sys/winks/gstksvideosrc.c b/sys/winks/gstksvideosrc.c index 0854b2940..f957aced4 100644 --- a/sys/winks/gstksvideosrc.c +++ b/sys/winks/gstksvideosrc.c @@ -20,11 +20,11 @@ /** * SECTION:element-ksvideosrc + * @title: ksvideosrc * * Provides low-latency video capture from WDM cameras on Windows. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 -v ksvideosrc do-stats=TRUE ! videoconvert ! dshowvideosink * ]| Capture from a camera and render using dshowvideosink. @@ -32,7 +32,7 @@ * gst-launch-1.0 -v ksvideosrc do-stats=TRUE ! image/jpeg, width=640, height=480 * ! jpegdec ! videoconvert ! dshowvideosink * ]| Capture from an MJPEG camera and render using dshowvideosink. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/winscreencap/gstdx9screencapsrc.c b/sys/winscreencap/gstdx9screencapsrc.c index 0e2cfb241..e7ee42984 100644 --- a/sys/winscreencap/gstdx9screencapsrc.c +++ b/sys/winscreencap/gstdx9screencapsrc.c @@ -19,6 +19,7 @@ /** * SECTION:element-dx9screencapsrc + * @title: dx9screencapsrc * * This element uses DirectX to capture the desktop or a portion of it. * The default is capturing the whole desktop, but #GstDX9ScreenCapSrc:x, @@ -27,8 +28,7 @@ * Use #GstDX9ScreenCapSrc:monitor for changing which monitor to capture * from. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 dx9screencapsrc ! videoconvert ! dshowvideosink * ]| Capture the desktop and display it. @@ -36,7 +36,7 @@ * gst-launch-1.0 dx9screencapsrc x=100 y=100 width=320 height=240 ! * videoconvert ! dshowvideosink * ]| Capture a portion of the desktop and display it. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H diff --git a/sys/winscreencap/gstgdiscreencapsrc.c b/sys/winscreencap/gstgdiscreencapsrc.c index 6476ed4f3..1ee0400d2 100644 --- a/sys/winscreencap/gstgdiscreencapsrc.c +++ b/sys/winscreencap/gstgdiscreencapsrc.c @@ -19,6 +19,7 @@ /** * SECTION:element-gdiscreencapsrc + * @title: gdiscreencapsrc * * This element uses GDI to capture the desktop or a portion of it. * The default is capturing the whole desktop, but #GstGDIScreenCapSrc:x, @@ -29,8 +30,7 @@ * * Set #GstGDIScreenCapSrc:cursor to TRUE to include the mouse cursor. * - * <refsect2> - * <title>Example pipelines</title> + * ## Example pipelines * |[ * gst-launch-1.0 gdiscreencapsrc ! videoconvert ! dshowvideosink * ]| Capture the desktop and display it. @@ -39,7 +39,7 @@ * ! videoconvert ! dshowvideosink * ]| Capture a portion of the desktop, including the mouse cursor, and * display it. - * </refsect2> + * */ #ifdef HAVE_CONFIG_H |