mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-06-05 15:08:53 +00:00
Code Issues 1 Projects Releases Wiki Activity

doc: Fix some gtk-doc comments

Browse source
This commit is contained in:
Thibault Saunier 2018-09-21 13:54:39 -03:00
parent 27ba8d24ec
commit 287897e465
28 changed files with 83 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
ext/gl/gstglsinkbin.c
View file

@ -202,7 +202,7 @@ gst_gl_sink_bin_class_init (GstGLSinkBinClass * klass)
/** /**
* GstGLSinkBin::create-element: * GstGLSinkBin::create-element:
* @object: the #GstGLSinkBin * @object: the #glsinkbin
* *
* Will be emitted when we need the processing element/s that this bin will use * Will be emitted when we need the processing element/s that this bin will use
* *

4
gst-libs/gst/audio/audio-converter.c
View file

@ -338,7 +338,7 @@ copy_config (GQuark field_id, const GValue * value, gpointer user_data)
* %FALSE and will try to update as much state as possible. The new state can * %FALSE and will try to update as much state as possible. The new state can
* then be retrieved and refined with gst_audio_converter_get_config(). * then be retrieved and refined with gst_audio_converter_get_config().
* *
* Look at the #GST_AUDIO_CONVERTER_OPT_* fields to check valid configuration * Look at the `GST_AUDIO_CONVERTER_OPT_*` fields to check valid configuration
* option and values. * option and values.
* *
* Returns: %TRUE when the new parameters could be set * Returns: %TRUE when the new parameters could be set
@ -1313,7 +1313,7 @@ converter_resample (GstAudioConverter * convert,
* Create a new #GstAudioConverter that is able to convert between @in and @out * Create a new #GstAudioConverter that is able to convert between @in and @out
* audio formats. * audio formats.
* *
* @config contains extra configuration options, see #GST_AUDIO_CONVERTER_OPT_* * @config contains extra configuration options, see `GST_AUDIO_CONVERTER_OPT_*`
* parameters for details about the options and values. * parameters for details about the options and values.
* *
* Returns: a #GstAudioConverter or %NULL if conversion is not possible. * Returns: a #GstAudioConverter or %NULL if conversion is not possible.

8
gst-libs/gst/audio/audio-converter.h
View file

@ -33,7 +33,7 @@ typedef struct _GstAudioConverter GstAudioConverter;
/** /**
* GST_AUDIO_CONVERTER_OPT_RESAMPLER_METHOD: * GST_AUDIO_CONVERTER_OPT_RESAMPLER_METHOD:
* *
* #GST_TYPE_AUDIO_RESAMPLER_METHOD, The resampler method to use when * #GstAudioResamplerMethod, The resampler method to use when
* changing sample rates. * changing sample rates.
* Default is #GST_AUDIO_RESAMPLER_METHOD_BLACKMAN_NUTTALL. * Default is #GST_AUDIO_RESAMPLER_METHOD_BLACKMAN_NUTTALL.
*/ */
@ -42,7 +42,7 @@ typedef struct _GstAudioConverter GstAudioConverter;
/** /**
* GST_AUDIO_CONVERTER_OPT_DITHER_METHOD: * GST_AUDIO_CONVERTER_OPT_DITHER_METHOD:
* *
* #GST_TYPE_AUDIO_DITHER_METHOD, The dither method to use when * #GstAudioDitherMethod, The dither method to use when
* changing bit depth. * changing bit depth.
* Default is #GST_AUDIO_DITHER_NONE. * Default is #GST_AUDIO_DITHER_NONE.
*/ */
@ -51,7 +51,7 @@ typedef struct _GstAudioConverter GstAudioConverter;
/** /**
* GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD: * GST_AUDIO_CONVERTER_OPT_NOISE_SHAPING_METHOD:
* *
* #GST_TYPE_AUDIO_NOISE_SHAPING_METHOD, The noise shaping method to use * #GstAudioNoiseShapingMethod, The noise shaping method to use
* to mask noise from quantization errors. * to mask noise from quantization errors.
* Default is #GST_AUDIO_NOISE_SHAPING_NONE. * Default is #GST_AUDIO_NOISE_SHAPING_NONE.
*/ */
@ -69,7 +69,7 @@ typedef struct _GstAudioConverter GstAudioConverter;
/** /**
* GST_AUDIO_CONVERTER_OPT_MIX_MATRIX: * GST_AUDIO_CONVERTER_OPT_MIX_MATRIX:
* *
* #GST_TYPE_VALUE_LIST, The channel mapping matrix. * #GST_TYPE_LIST, The channel mapping matrix.
* *
* The matrix coefficients must be between -1 and 1: the number of rows is equal * The matrix coefficients must be between -1 and 1: the number of rows is equal
* to the number of output channels and the number of columns is equal to the * to the number of output channels and the number of columns is equal to the

1
gst-libs/gst/gl/gstglquery.c
View file

@ -22,7 +22,6 @@
* SECTION:gstglquery * SECTION:gstglquery
* @short_description: OpenGL query abstraction * @short_description: OpenGL query abstraction
* @title: GstGLQuery * @title: GstGLQuery
* @see_also:
* *
* A #GstGLQuery represents and holds an OpenGL query object. Various types of * A #GstGLQuery represents and holds an OpenGL query object. Various types of
* queries can be run or counters retrieved. * queries can be run or counters retrieved.

2
gst-libs/gst/pbutils/encoding-profile.c
View file

@ -696,7 +696,7 @@ gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence)
/** /**
* gst_encoding_profile_set_enabled: * gst_encoding_profile_set_enabled:
* @profile: a #GstEncodingProfile * @profile: a #GstEncodingProfile
* @enabled: %FALSE to disable #profile, %TRUE to enable it * @enabled: %FALSE to disable @profile, %TRUE to enable it
* *
* Set whether the profile should be used or not. * Set whether the profile should be used or not.
* *

2
gst-libs/gst/pbutils/encoding-target.c
View file

@ -18,7 +18,7 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/** /**
* SECTION: encoding-target * SECTION: encoding-target:
* On top of the notion of profiles, we implement the notion of EncodingTarget. * On top of the notion of profiles, we implement the notion of EncodingTarget.
* Encoding Targets are basically a higher level of abstraction to define formats * Encoding Targets are basically a higher level of abstraction to define formats
* for specific target types. Those can define several GstEncodingProfiles with * for specific target types. Those can define several GstEncodingProfiles with

2
gst-libs/gst/pbutils/gstaudiovisualizer.c
View file

@ -29,7 +29,7 @@
* changes). * changes).
* *
* It also provides several background shading effects. These effects are * It also provides several background shading effects. These effects are
* applied to a previous picture before the render() implementation can draw a * applied to a previous picture before the `render()` implementation can draw a
* new frame. * new frame.
*/ */

2
gst-libs/gst/rtp/gstrtpbaseaudiopayload.c
View file

@ -42,7 +42,7 @@
* To use this base class, your child element needs to call either * To use this base class, your child element needs to call either
* gst_rtp_base_audio_payload_set_frame_based() or * gst_rtp_base_audio_payload_set_frame_based() or
* gst_rtp_base_audio_payload_set_sample_based(). This is usually done in the * gst_rtp_base_audio_payload_set_sample_based(). This is usually done in the
* element's _init() function. Then, the child element must call either * element's `_init()` function. Then, the child element must call either
* gst_rtp_base_audio_payload_set_frame_options(), * gst_rtp_base_audio_payload_set_frame_options(),
* gst_rtp_base_audio_payload_set_sample_options() or * gst_rtp_base_audio_payload_set_sample_options() or
* gst_rtp_base_audio_payload_set_samplebits_options. Since * gst_rtp_base_audio_payload_set_samplebits_options. Since

2
gst-libs/gst/tag/tags.c
View file

@ -497,7 +497,7 @@ beach:
* In GStreamer, image tags are #GstSample<!-- -->s containing the raw image * In GStreamer, image tags are #GstSample<!-- -->s containing the raw image
* data, with the sample caps describing the content type of the image * data, with the sample caps describing the content type of the image
* (e.g. image/jpeg, image/png, text/uri-list). The sample info may contain * (e.g. image/jpeg, image/png, text/uri-list). The sample info may contain
* an additional 'image-type' field of #GST_TYPE_TAG_IMAGE_TYPE to describe * an additional 'image-type' field of #GstTagImageType to describe
* the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE * the type of image (front cover, back cover etc.). #GST_TAG_PREVIEW_IMAGE
* tags should not carry an image type, their type is already indicated via * tags should not carry an image type, their type is already indicated via
* the special tag name. * the special tag name.

16
gst-libs/gst/video/gstvideoaggregator.c
View file

@ -243,8 +243,8 @@ gst_video_aggregator_pad_init (GstVideoAggregatorPad * vaggpad)
* Checks if the pad currently has a buffer queued that is going to be used * Checks if the pad currently has a buffer queued that is going to be used
* for the current output frame. * for the current output frame.
* *
* This must only be called from the aggregate_frames() virtual method, * This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
* or from the prepare_frame() virtual method of the aggregator pads. * or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
* *
* Returns: %TRUE if the pad has currently a buffer queued * Returns: %TRUE if the pad has currently a buffer queued
*/ */
@ -263,10 +263,10 @@ gst_video_aggregator_pad_has_current_buffer (GstVideoAggregatorPad * pad)
* Returns the currently queued buffer that is going to be used * Returns the currently queued buffer that is going to be used
* for the current output frame. * for the current output frame.
* *
* This must only be called from the aggregate_frames() virtual method, * This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
* or from the prepare_frame() virtual method of the aggregator pads. * or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
* *
* The return value is only valid until aggregate_frames() or prepare_frames() * The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame
* returns. * returns.
* *
* Returns: (transfer none): The currently queued buffer * Returns: (transfer none): The currently queued buffer
@ -286,10 +286,10 @@ gst_video_aggregator_pad_get_current_buffer (GstVideoAggregatorPad * pad)
* Returns the currently prepared video frame that has to be aggregated into * Returns the currently prepared video frame that has to be aggregated into
* the current output frame. * the current output frame.
* *
* This must only be called from the aggregate_frames() virtual method, * This must only be called from the #GstVideoAggregatorClass::aggregate_frames virtual method,
* or from the prepare_frame() virtual method of the aggregator pads. * or from the #GstVideoAggregatorPadClass::prepare_frame virtual method of the aggregator pads.
* *
* The return value is only valid until aggregate_frames() or prepare_frames() * The return value is only valid until #GstVideoAggregatorClass::aggregate_frames or #GstVideoAggregatorPadClass::prepare_frame
* returns. * returns.
* *
* Returns: (transfer none): The currently prepared video frame * Returns: (transfer none): The currently prepared video frame

1
gst-libs/gst/video/gstvideodecoder.c
View file

@ -26,7 +26,6 @@
* SECTION:gstvideodecoder * SECTION:gstvideodecoder
* @title: GstVideoDecoder * @title: GstVideoDecoder
* @short_description: Base class for video decoders * @short_description: Base class for video decoders
* @see_also:
* *
* This base class is for video decoders turning encoded data into raw video * This base class is for video decoders turning encoded data into raw video
* frames. * frames.

1
gst-libs/gst/video/gstvideoencoder.c
View file

@ -26,7 +26,6 @@
* SECTION:gstvideoencoder * SECTION:gstvideoencoder
* @title: GstVideoEncoder * @title: GstVideoEncoder
* @short_description: Base class for video encoders * @short_description: Base class for video encoders
* @see_also:
* *
* This base class is for video encoders turning raw video into * This base class is for video encoders turning raw video into
* encoded video data. * encoded video data.

2
gst-libs/gst/video/video-converter.c
View file

@ -2596,7 +2596,7 @@ copy_config (GQuark field_id, const GValue * value, gpointer user_data)
* %FALSE and will try to update as much state as possible. The new state can * %FALSE and will try to update as much state as possible. The new state can
* then be retrieved and refined with gst_video_converter_get_config(). * then be retrieved and refined with gst_video_converter_get_config().
* *
* Look at the #GST_VIDEO_CONVERTER_OPT_* fields to check valid configuration * Look at the `GST_VIDEO_CONVERTER_OPT_*` fields to check valid configuration
* option and values. * option and values.
* *
* Returns: %TRUE when @config could be set. * Returns: %TRUE when @config could be set.

16
gst-libs/gst/video/video-converter.h
View file

@ -27,7 +27,7 @@ G_BEGIN_DECLS
/** /**
* GST_VIDEO_CONVERTER_OPT_RESAMPLER_METHOD: * GST_VIDEO_CONVERTER_OPT_RESAMPLER_METHOD:
* *
* #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for * #GstVideoResamplerMethod, The resampler method to use for
* resampling. Other options for the resampler can be used, see * resampling. Other options for the resampler can be used, see
* the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC * the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC
*/ */
@ -35,7 +35,7 @@ G_BEGIN_DECLS
/** /**
* GST_VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD: * GST_VIDEO_CONVERTER_OPT_CHROMA_RESAMPLER_METHOD:
* *
* #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for * #GstVideoChromaMethod, The resampler method to use for
* chroma resampling. Other options for the resampler can be used, see * chroma resampling. Other options for the resampler can be used, see
* the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR * the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR
*/ */
@ -51,7 +51,7 @@ G_BEGIN_DECLS
/** /**
* GST_VIDEO_CONVERTER_OPT_DITHER_METHOD: * GST_VIDEO_CONVERTER_OPT_DITHER_METHOD:
* *
* #GST_TYPE_VIDEO_DITHER_METHOD, The dither method to use when * #GstVideoDitherMethod, The dither method to use when
* changing bit depth. * changing bit depth.
* Default is #GST_VIDEO_DITHER_BAYER. * Default is #GST_VIDEO_DITHER_BAYER.
*/ */
@ -156,7 +156,7 @@ typedef enum {
/** /**
* GST_VIDEO_CONVERTER_OPT_ALPHA_MODE: * GST_VIDEO_CONVERTER_OPT_ALPHA_MODE:
* *
* #GST_TYPE_VIDEO_ALPHA_MODE, the alpha mode to use. * #GstVideoAlphaMode, the alpha mode to use.
* Default is #GST_VIDEO_ALPHA_MODE_COPY. * Default is #GST_VIDEO_ALPHA_MODE_COPY.
*/ */
#define GST_VIDEO_CONVERTER_OPT_ALPHA_MODE "GstVideoConverter.alpha-mode" #define GST_VIDEO_CONVERTER_OPT_ALPHA_MODE "GstVideoConverter.alpha-mode"
@ -190,7 +190,7 @@ typedef enum {
/** /**
* GST_VIDEO_CONVERTER_OPT_CHROMA_MODE: * GST_VIDEO_CONVERTER_OPT_CHROMA_MODE:
* *
* #GST_TYPE_VIDEO_CHROMA_MODE, set the chroma resample mode subsampled * #GstVideoChromaMode, set the chroma resample mode subsampled
* formats. Default is #GST_VIDEO_CHROMA_MODE_FULL. * formats. Default is #GST_VIDEO_CHROMA_MODE_FULL.
*/ */
#define GST_VIDEO_CONVERTER_OPT_CHROMA_MODE "GstVideoConverter.chroma-mode" #define GST_VIDEO_CONVERTER_OPT_CHROMA_MODE "GstVideoConverter.chroma-mode"
@ -217,7 +217,7 @@ typedef enum {
/** /**
* GST_VIDEO_CONVERTER_OPT_MATRIX_MODE: * GST_VIDEO_CONVERTER_OPT_MATRIX_MODE:
* *
* #GST_TYPE_VIDEO_MATRIX_MODE, set the color matrix conversion mode for * #GstVideoMatrixMode, set the color matrix conversion mode for
* converting between Y'PbPr and non-linear RGB (R'G'B'). * converting between Y'PbPr and non-linear RGB (R'G'B').
* Default is #GST_VIDEO_MATRIX_MODE_FULL. * Default is #GST_VIDEO_MATRIX_MODE_FULL.
*/ */
@ -237,7 +237,7 @@ typedef enum {
/** /**
* GST_VIDEO_CONVERTER_OPT_GAMMA_MODE: * GST_VIDEO_CONVERTER_OPT_GAMMA_MODE:
* *
* #GST_TYPE_VIDEO_GAMMA_MODE, set the gamma mode. * #GstVideoGammaMode, set the gamma mode.
* Default is #GST_VIDEO_GAMMA_MODE_NONE. * Default is #GST_VIDEO_GAMMA_MODE_NONE.
*/ */
#define GST_VIDEO_CONVERTER_OPT_GAMMA_MODE "GstVideoConverter.gamma-mode" #define GST_VIDEO_CONVERTER_OPT_GAMMA_MODE "GstVideoConverter.gamma-mode"
@ -260,7 +260,7 @@ typedef enum {
/** /**
* GST_VIDEO_CONVERTER_OPT_PRIMARIES_MODE: * GST_VIDEO_CONVERTER_OPT_PRIMARIES_MODE:
* *
* #GST_TYPE_VIDEO_PRIMARIES_MODE, set the primaries conversion mode. * #GstVideoPrimariesMode, set the primaries conversion mode.
* Default is #GST_VIDEO_PRIMARIES_MODE_NONE. * Default is #GST_VIDEO_PRIMARIES_MODE_NONE.
*/ */
#define GST_VIDEO_CONVERTER_OPT_PRIMARIES_MODE "GstVideoConverter.primaries-mode" #define GST_VIDEO_CONVERTER_OPT_PRIMARIES_MODE "GstVideoConverter.primaries-mode"

4
gst-libs/gst/video/video-info.h
View file

@ -106,11 +106,11 @@ GstVideoInterlaceMode gst_video_interlace_mode_from_string (const gchar * mode
* @GST_VIDEO_MULTIVIEW_MODE_MULTIVIEW_FRAME_BY_FRAME: Multiple * @GST_VIDEO_MULTIVIEW_MODE_MULTIVIEW_FRAME_BY_FRAME: Multiple
* independent views are provided in separate frames in sequence. * independent views are provided in separate frames in sequence.
* This method only applies to raw video buffers at the moment. * This method only applies to raw video buffers at the moment.
* Specific view identification is via the #GstVideoMultiviewMeta * Specific view identification is via the `GstVideoMultiviewMeta`
* and #GstVideoMeta(s) on raw video buffers. * and #GstVideoMeta(s) on raw video buffers.
* @GST_VIDEO_MULTIVIEW_MODE_SEPARATED: Multiple views are * @GST_VIDEO_MULTIVIEW_MODE_SEPARATED: Multiple views are
* provided as separate #GstMemory framebuffers attached to each * provided as separate #GstMemory framebuffers attached to each
* #GstBuffer, described by the #GstVideoMultiviewMeta * #GstBuffer, described by the `GstVideoMultiviewMeta`
* and #GstVideoMeta(s) * and #GstVideoMeta(s)
* *
* All possible stereoscopic 3D and multiview representations. * All possible stereoscopic 3D and multiview representations.

3
gst-libs/gst/video/video-scaler.c
View file

@ -1380,8 +1380,7 @@ no_func:
* *
* Vertically combine @width pixels in the lines in @src_lines to @dest. * Vertically combine @width pixels in the lines in @src_lines to @dest.
* @dest is the location of the target line at @dest_offset and * @dest is the location of the target line at @dest_offset and
* @srcs are the input lines for @dest_offset, as obtained with * @srcs are the input lines for @dest_offset.
* gst_video_scaler_get_info().
*/ */
void void
gst_video_scaler_vertical (GstVideoScaler * scale, GstVideoFormat format, gst_video_scaler_vertical (GstVideoScaler * scale, GstVideoFormat format,

2
gst-libs/gst/video/video-scaler.h
View file

@ -31,7 +31,7 @@ G_BEGIN_DECLS
/** /**
* GST_VIDEO_SCALER_OPT_DITHER_METHOD: * GST_VIDEO_SCALER_OPT_DITHER_METHOD:
* *
* #GST_TYPE_VIDEO_DITHER_METHOD, The dither method to use for propagating * #GstVideoDitherMethod, The dither method to use for propagating
* quatization errors. * quatization errors.
*/ */
#define GST_VIDEO_SCALER_OPT_DITHER_METHOD "GstVideoScaler.dither-method" #define GST_VIDEO_SCALER_OPT_DITHER_METHOD "GstVideoScaler.dither-method"

6
gst-libs/gst/video/videooverlay.c
View file

@ -85,7 +85,7 @@
* ## Two basic usage scenarios * ## Two basic usage scenarios
* *
* There are two basic usage scenarios: in the simplest case, the application * There are two basic usage scenarios: in the simplest case, the application
* uses #playbin or #plasink or knows exactly what particular element is used * uses #playbin or #playsink or knows exactly what particular element is used
* for video output, which is usually the case when the application creates * for video output, which is usually the case when the application creates
* the videosink to use (e.g. #xvimagesink, #ximagesink, etc.) itself; in this * the videosink to use (e.g. #xvimagesink, #ximagesink, etc.) itself; in this
* case, the application can just create the videosink element, create and * case, the application can just create the videosink element, create and
@ -118,10 +118,10 @@
* windowing systems are not thread-safe at all and a lot of care would be * windowing systems are not thread-safe at all and a lot of care would be
* required to co-ordinate the toolkit and window system calls of the * required to co-ordinate the toolkit and window system calls of the
* different threads (Gtk+ users please note: prior to Gtk+ 2.18 * different threads (Gtk+ users please note: prior to Gtk+ 2.18
* GDK_WINDOW_XID() was just a simple structure access, so generally fine to do * `GDK_WINDOW_XID` was just a simple structure access, so generally fine to do
* within the bus sync handler; this macro was changed to a function call in * within the bus sync handler; this macro was changed to a function call in
* Gtk+ 2.18 and later, which is likely to cause problems when called from a * Gtk+ 2.18 and later, which is likely to cause problems when called from a
* sync handler; see below for a better approach without GDK_WINDOW_XID() * sync handler; see below for a better approach without `GDK_WINDOW_XID`
* used in the callback). * used in the callback).
* *
* ## GstVideoOverlay and Gtk+ * ## GstVideoOverlay and Gtk+

12
gst/playback/gstdecodebin2.c
View file

@ -822,16 +822,16 @@ gst_decode_bin_class_init (GstDecodeBinClass * klass)
* #GstElementFactory that can be used to handle the given @caps. For each of * #GstElementFactory that can be used to handle the given @caps. For each of
* those factories, this signal is emitted. * those factories, this signal is emitted.
* *
* The signal handler should return a #GST_TYPE_AUTOPLUG_SELECT_RESULT enum * The signal handler should return a #GstAutoplugSelectResult enum
* value indicating what decodebin should do next. * value indicating what decodebin should do next.
* *
* A value of #GST_AUTOPLUG_SELECT_TRY will try to autoplug an element from * A value of #GstAutoplugSelectResult::try will try to autoplug an element from
* @factory. * @factory.
* *
* A value of #GST_AUTOPLUG_SELECT_EXPOSE will expose @pad without plugging * A value of #GstAutoplugSelectResult::expose will expose @pad without plugging
* any element to it. * any element to it.
* *
* A value of #GST_AUTOPLUG_SELECT_SKIP will skip @factory and move to the * A value of #GstAutoplugSelectResult::skip will skip @factory and move to the
* next factory. * next factory.
* *
* > The signal handler will not be invoked if any of the previously * > The signal handler will not be invoked if any of the previously
@ -840,9 +840,9 @@ gst_decode_bin_class_init (GstDecodeBinClass * klass)
* > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get * > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get
* > registered next (again, if any) can override that decision. * > registered next (again, if any) can override that decision.
* *
* Returns: a #GST_TYPE_AUTOPLUG_SELECT_RESULT that indicates the required * Returns: a #GstAutoplugSelectResult that indicates the required
* operation. the default handler will always return * operation. the default handler will always return
* #GST_AUTOPLUG_SELECT_TRY. * #GstAutoplugSelectResult::try.
*/ */
gst_decode_bin_signals[SIGNAL_AUTOPLUG_SELECT] = gst_decode_bin_signals[SIGNAL_AUTOPLUG_SELECT] =
g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass), g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass),

2
gst/playback/gstdecodebin3.c
View file

@ -64,7 +64,7 @@
* *
*/ */
/** /*
* Global design * Global design
* *
* 1) From sink pad to elementary streams (GstParseBin) * 1) From sink pad to elementary streams (GstParseBin)

20
gst/playback/gstparsebin.c
View file

@ -736,16 +736,16 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
* #GstElementFactory that can be used to handle the given @caps. For each of * #GstElementFactory that can be used to handle the given @caps. For each of
* those factories, this signal is emitted. * those factories, this signal is emitted.
* *
* The signal handler should return a #GST_TYPE_AUTOPLUG_SELECT_RESULT enum * The signal handler should return a #GstAutoplugSelectResult enum
* value indicating what ParseBin should do next. * value indicating what ParseBin should do next.
* *
* A value of #GST_AUTOPLUG_SELECT_TRY will try to autoplug an element from * A value of #GstAutoplugSelectResult::try will try to autoplug an element from
* @factory. * @factory.
* *
* A value of #GST_AUTOPLUG_SELECT_EXPOSE will expose @pad without plugging * A value of #GstAutoplugSelectResult::expose will expose @pad without plugging
* any element to it. * any element to it.
* *
* A value of #GST_AUTOPLUG_SELECT_SKIP will skip @factory and move to the * A value of #GstAutoplugSelectResult::skip will skip @factory and move to the
* next factory. * next factory.
* *
* > The signal handler will not be invoked if any of the previously * > The signal handler will not be invoked if any of the previously
@ -754,9 +754,9 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
* > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get * > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get
* > registered next (again, if any) can override that decision. * > registered next (again, if any) can override that decision.
* *
* Returns: a #GST_TYPE_AUTOPLUG_SELECT_RESULT that indicates the required * Returns: a #GstAutoplugSelectResult that indicates the required
* operation. the default handler will always return * operation. the default handler will always return
* #GST_AUTOPLUG_SELECT_TRY. * #GstAutoplugSelectResult::try.
*/ */
gst_parse_bin_signals[SIGNAL_AUTOPLUG_SELECT] = gst_parse_bin_signals[SIGNAL_AUTOPLUG_SELECT] =
g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass), g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass),
@ -789,7 +789,7 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
GST_TYPE_QUERY | G_SIGNAL_TYPE_STATIC_SCOPE); GST_TYPE_QUERY | G_SIGNAL_TYPE_STATIC_SCOPE);
/** /**
* GstParseBin::drained * GstParseBin::drained:
* @bin: The ParseBin * @bin: The ParseBin
* *
* This signal is emitted once ParseBin has finished parsing all the data. * This signal is emitted once ParseBin has finished parsing all the data.
@ -813,7 +813,7 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
GST_TYPE_CAPS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); GST_TYPE_CAPS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**
* GstParseBin::expose-all-streams * GstParseBin::expose-all-streams:
* *
* Expose streams of unknown type. * Expose streams of unknown type.
* *
@ -829,7 +829,7 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**
* GstParseBin2::connection-speed * GstParseBin2::connection-speed:
* *
* Network connection speed in kbps (0 = unknownw) * Network connection speed in kbps (0 = unknownw)
*/ */
@ -839,8 +839,6 @@ gst_parse_bin_class_init (GstParseBinClass * klass)
0, G_MAXUINT64 / 1000, DEFAULT_CONNECTION_SPEED, 0, G_MAXUINT64 / 1000, DEFAULT_CONNECTION_SPEED,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
klass->autoplug_continue = klass->autoplug_continue =
GST_DEBUG_FUNCPTR (gst_parse_bin_autoplug_continue); GST_DEBUG_FUNCPTR (gst_parse_bin_autoplug_continue);
klass->autoplug_factories = klass->autoplug_factories =

4
gst/playback/gstplayback.c
View file

@ -17,8 +17,8 @@
* Boston, MA 02110-1301, USA. * Boston, MA 02110-1301, USA.
*/ */
/** /**
* SECTION:plugin-playback * SECTION:plugin-playback:
* short_description: Set of elements to create dynamic pipelines (or part of it) to play * @short_description: Set of elements to create dynamic pipelines (or part of it) to play
* media files. * media files.
*/ */

28
gst/playback/gstplaybin2.c
View file

@ -970,7 +970,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**
* GstPlayBin:ring-buffer-max-size * GstPlayBin:ring-buffer-max-size:
* *
* The maximum size of the ring buffer in bytes. If set to 0, the ring * The maximum size of the ring buffer in bytes. If set to 0, the ring
* buffer is disabled. Default 0. * buffer is disabled. Default 0.
@ -1043,7 +1043,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE); g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE);
/** /**
* GstPlayBin::video-changed * GstPlayBin::video-changed:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* *
* This signal is emitted whenever the number or order of the video * This signal is emitted whenever the number or order of the video
@ -1079,7 +1079,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, audio_changed), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, audio_changed), NULL, NULL,
g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE); g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE);
/** /**
* GstPlayBin::text-changed * GstPlayBin::text-changed:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* *
* This signal is emitted whenever the number or order of the text * This signal is emitted whenever the number or order of the text
@ -1098,7 +1098,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE); g_cclosure_marshal_generic, G_TYPE_NONE, 0, G_TYPE_NONE);
/** /**
* GstPlayBin::video-tags-changed * GstPlayBin::video-tags-changed:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: stream index with changed tags * @stream: stream index with changed tags
* *
@ -1116,7 +1116,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_INT); g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_INT);
/** /**
* GstPlayBin::audio-tags-changed * GstPlayBin::audio-tags-changed:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: stream index with changed tags * @stream: stream index with changed tags
* *
@ -1134,7 +1134,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_INT); g_cclosure_marshal_generic, G_TYPE_NONE, 1, G_TYPE_INT);
/** /**
* GstPlayBin::text-tags-changed * GstPlayBin::text-tags-changed:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: stream index with changed tags * @stream: stream index with changed tags
* *
@ -1192,7 +1192,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_ELEMENT); g_cclosure_marshal_generic, G_TYPE_NONE, 1, GST_TYPE_ELEMENT);
/** /**
* GstPlayBin::get-video-tags * GstPlayBin::get-video-tags:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: a video stream number * @stream: a video stream number
* *
@ -1208,7 +1208,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, get_video_tags), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, get_video_tags), NULL, NULL,
g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT); g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT);
/** /**
* GstPlayBin::get-audio-tags * GstPlayBin::get-audio-tags:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: an audio stream number * @stream: an audio stream number
* *
@ -1224,7 +1224,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, get_audio_tags), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, get_audio_tags), NULL, NULL,
g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT); g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT);
/** /**
* GstPlayBin::get-text-tags * GstPlayBin::get-text-tags:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: a text stream number * @stream: a text stream number
* *
@ -1240,14 +1240,14 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, get_text_tags), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, get_text_tags), NULL, NULL,
g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT); g_cclosure_marshal_generic, GST_TYPE_TAG_LIST, 1, G_TYPE_INT);
/** /**
* GstPlayBin::convert-sample * GstPlayBin::convert-sample:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @caps: the target format of the frame * @caps: the target format of the frame
* *
* Action signal to retrieve the currently playing video frame in the format * Action signal to retrieve the currently playing video frame in the format
* specified by @caps. * specified by @caps.
* If @caps is %NULL, no conversion will be performed and this function is * If @caps is %NULL, no conversion will be performed and this function is
* equivalent to the #GstPlayBin::sample property. * equivalent to the #GstPlayBin:sample property.
* *
* Returns: a #GstSample of the current video frame converted to #caps. * Returns: a #GstSample of the current video frame converted to #caps.
* The caps on the sample will describe the final layout of the buffer data. * The caps on the sample will describe the final layout of the buffer data.
@ -1261,7 +1261,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
g_cclosure_marshal_generic, GST_TYPE_SAMPLE, 1, GST_TYPE_CAPS); g_cclosure_marshal_generic, GST_TYPE_SAMPLE, 1, GST_TYPE_CAPS);
/** /**
* GstPlayBin::get-video-pad * GstPlayBin::get-video-pad:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: a video stream number * @stream: a video stream number
* *
@ -1278,7 +1278,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, get_video_pad), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, get_video_pad), NULL, NULL,
g_cclosure_marshal_generic, GST_TYPE_PAD, 1, G_TYPE_INT); g_cclosure_marshal_generic, GST_TYPE_PAD, 1, G_TYPE_INT);
/** /**
* GstPlayBin::get-audio-pad * GstPlayBin::get-audio-pad:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: an audio stream number * @stream: an audio stream number
* *
@ -1295,7 +1295,7 @@ gst_play_bin_class_init (GstPlayBinClass * klass)
G_STRUCT_OFFSET (GstPlayBinClass, get_audio_pad), NULL, NULL, G_STRUCT_OFFSET (GstPlayBinClass, get_audio_pad), NULL, NULL,
g_cclosure_marshal_generic, GST_TYPE_PAD, 1, G_TYPE_INT); g_cclosure_marshal_generic, GST_TYPE_PAD, 1, G_TYPE_INT);
/** /**
* GstPlayBin::get-text-pad * GstPlayBin::get-text-pad:
* @playbin: a #GstPlayBin * @playbin: a #GstPlayBin
* @stream: a text stream number * @stream: a text stream number
* *

2
gst/playback/gstplaybin3.c
View file

@ -1037,7 +1037,7 @@ gst_play_bin3_class_init (GstPlayBin3Class * klass)
* Action signal to retrieve the currently playing video frame in the format * Action signal to retrieve the currently playing video frame in the format
* specified by @caps. * specified by @caps.
* If @caps is %NULL, no conversion will be performed and this function is * If @caps is %NULL, no conversion will be performed and this function is
* equivalent to the #GstPlayBin3::sample property. * equivalent to the #GstPlayBin3:sample property.
* *
* Returns: a #GstSample of the current video frame converted to #caps. * Returns: a #GstSample of the current video frame converted to #caps.
* The caps on the sample will describe the final layout of the buffer data. * The caps on the sample will describe the final layout of the buffer data.

4
gst/playback/gstplaysink.c
View file

@ -617,14 +617,14 @@ gst_play_sink_class_init (GstPlaySinkClass * klass)
reconfigure), NULL, NULL, g_cclosure_marshal_generic, G_TYPE_BOOLEAN, reconfigure), NULL, NULL, g_cclosure_marshal_generic, G_TYPE_BOOLEAN,
0, G_TYPE_NONE); 0, G_TYPE_NONE);
/** /**
* GstPlaySink::convert-sample * GstPlaySink::convert-sample:
* @playsink: a #GstPlaySink * @playsink: a #GstPlaySink
* @caps: the target format of the sample * @caps: the target format of the sample
* *
* Action signal to retrieve the currently playing video sample in the format * Action signal to retrieve the currently playing video sample in the format
* specified by @caps. * specified by @caps.
* If @caps is %NULL, no conversion will be performed and this function is * If @caps is %NULL, no conversion will be performed and this function is
* equivalent to the #GstPlaySink::sample property. * equivalent to the #GstPlaySink:sample property.
* *
* Returns: a #GstSample of the current video sample converted to #caps. * Returns: a #GstSample of the current video sample converted to #caps.
* The caps in the sample will describe the final layout of the buffer data. * The caps in the sample will describe the final layout of the buffer data.

16
gst/playback/gsturidecodebin.c
View file

@ -462,7 +462,7 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass)
DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); DEFAULT_USE_BUFFERING, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**
* GstURIDecodeBin::expose-all-streams * GstURIDecodeBin::expose-all-streams:
* *
* Expose streams of unknown type. * Expose streams of unknown type.
* *
@ -478,7 +478,7 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass)
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/** /**
* GstURIDecodeBin::ring-buffer-max-size * GstURIDecodeBin::ring-buffer-max-size:
* *
* The maximum size of the ring buffer in kilobytes. If set to 0, the ring * The maximum size of the ring buffer in kilobytes. If set to 0, the ring
* buffer is disabled. Default is 0. * buffer is disabled. Default is 0.
@ -602,16 +602,16 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass)
* #GstElementFactory that can be used to handle the given @caps. For each of * #GstElementFactory that can be used to handle the given @caps. For each of
* those factories, this signal is emitted. * those factories, this signal is emitted.
* *
* The signal handler should return a #GST_TYPE_AUTOPLUG_SELECT_RESULT enum * The signal handler should return a #GstAutoplugSelectResult enum
* value indicating what decodebin should do next. * value indicating what decodebin should do next.
* *
* A value of #GST_AUTOPLUG_SELECT_TRY will try to autoplug an element from * A value of #GstAutoplugSelectResult::try will try to autoplug an element from
* @factory. * @factory.
* *
* A value of #GST_AUTOPLUG_SELECT_EXPOSE will expose @pad without plugging * A value of #GstAutoplugSelectResult::expose will expose @pad without plugging
* any element to it. * any element to it.
* *
* A value of #GST_AUTOPLUG_SELECT_SKIP will skip @factory and move to the * A value of #GstAutoplugSelectResult::skip will skip @factory and move to the
* next factory. * next factory.
* *
* > The signal handler will not be invoked if any of the previously * > The signal handler will not be invoked if any of the previously
@ -620,9 +620,9 @@ gst_uri_decode_bin_class_init (GstURIDecodeBinClass * klass)
* > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get * > GST_AUTOPLUG_SELECT_TRY from one signal handler, handlers that get
* > registered next (again, if any) can override that decision. * > registered next (again, if any) can override that decision.
* *
* Returns: a #GST_TYPE_AUTOPLUG_SELECT_RESULT that indicates the required * Returns: a #GstAutoplugSelectResult that indicates the required
* operation. The default handler will always return * operation. The default handler will always return
* #GST_AUTOPLUG_SELECT_TRY. * #GstAutoplugSelectResult::try.
*/ */
gst_uri_decode_bin_signals[SIGNAL_AUTOPLUG_SELECT] = gst_uri_decode_bin_signals[SIGNAL_AUTOPLUG_SELECT] =
g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass), g_signal_new ("autoplug-select", G_TYPE_FROM_CLASS (klass),

4
gst/tcp/gstmultifdsink.c
View file

@ -336,7 +336,7 @@ gst_multi_fd_sink_class_init (GstMultiFdSinkClass * klass)
* *
* @gstmultifdsink still holds a handle to @fd so it is possible to call * @gstmultifdsink still holds a handle to @fd so it is possible to call
* the get-stats signal from this callback. For the same reason it is * the get-stats signal from this callback. For the same reason it is
* not safe to close() and reuse @fd in this callback. * not safe to `close()` and reuse @fd in this callback.
*/ */
gst_multi_fd_sink_signals[SIGNAL_CLIENT_REMOVED] = gst_multi_fd_sink_signals[SIGNAL_CLIENT_REMOVED] =
g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass), g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
@ -353,7 +353,7 @@ gst_multi_fd_sink_class_init (GstMultiFdSinkClass * klass)
* *
* In this callback, @gstmultifdsink has removed all the information * In this callback, @gstmultifdsink has removed all the information
* associated with @fd and it is therefore not possible to call get-stats * associated with @fd and it is therefore not possible to call get-stats
* with @fd. It is however safe to close() and reuse @fd in the callback. * with @fd. It is however safe to `close()` and reuse @fd in the callback.
*/ */
gst_multi_fd_sink_signals[SIGNAL_CLIENT_FD_REMOVED] = gst_multi_fd_sink_signals[SIGNAL_CLIENT_FD_REMOVED] =
g_signal_new ("client-fd-removed", G_TYPE_FROM_CLASS (klass), g_signal_new ("client-fd-removed", G_TYPE_FROM_CLASS (klass),

4
gst/tcp/gstmultisocketsink.c
View file

@ -366,7 +366,7 @@ gst_multi_socket_sink_class_init (GstMultiSocketSinkClass * klass)
* *
* @gstmultisocketsink still holds a handle to @socket so it is possible to call * @gstmultisocketsink still holds a handle to @socket so it is possible to call
* the get-stats signal from this callback. For the same reason it is * the get-stats signal from this callback. For the same reason it is
* not safe to close() and reuse @socket in this callback. * not safe to `close()` and reuse @socket in this callback.
*/ */
gst_multi_socket_sink_signals[SIGNAL_CLIENT_REMOVED] = gst_multi_socket_sink_signals[SIGNAL_CLIENT_REMOVED] =
g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass), g_signal_new ("client-removed", G_TYPE_FROM_CLASS (klass),
@ -383,7 +383,7 @@ gst_multi_socket_sink_class_init (GstMultiSocketSinkClass * klass)
* *
* In this callback, @gstmultisocketsink has removed all the information * In this callback, @gstmultisocketsink has removed all the information
* associated with @socket and it is therefore not possible to call get-stats * associated with @socket and it is therefore not possible to call get-stats
* with @socket. It is however safe to close() and reuse @fd in the callback. * with @socket. It is however safe to `close()` and reuse @fd in the callback.
*/ */
gst_multi_socket_sink_signals[SIGNAL_CLIENT_SOCKET_REMOVED] = gst_multi_socket_sink_signals[SIGNAL_CLIENT_SOCKET_REMOVED] =
g_signal_new ("client-socket-removed", G_TYPE_FROM_CLASS (klass), g_signal_new ("client-socket-removed", G_TYPE_FROM_CLASS (klass),