mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-17 11:45:25 +00:00
docs: handle warnings emitted by gtk-doc
This is useful and in most cases someone had put arbitrary markup into the docs, misspelled xref'ed symbols, forgot to add stuff to the docs etc..
This commit is contained in:
parent
3e8d17e650
commit
01bbdd6bdf
15 changed files with 25 additions and 24 deletions
|
@ -188,6 +188,7 @@
|
||||||
<xi:include href="xml/gsttag.xml" />
|
<xi:include href="xml/gsttag.xml" />
|
||||||
<xi:include href="xml/gsttagvorbis.xml" />
|
<xi:include href="xml/gsttagvorbis.xml" />
|
||||||
<xi:include href="xml/gsttagid3.xml" />
|
<xi:include href="xml/gsttagid3.xml" />
|
||||||
|
<xi:include href="xml/gsttagexif.xml" />
|
||||||
<xi:include href="xml/gsttagxmp.xml" />
|
<xi:include href="xml/gsttagxmp.xml" />
|
||||||
<xi:include href="xml/gsttagxmpwriter.xml" />
|
<xi:include href="xml/gsttagxmpwriter.xml" />
|
||||||
<xi:include href="xml/gsttagdemux.xml" />
|
<xi:include href="xml/gsttagdemux.xml" />
|
||||||
|
|
|
@ -1743,6 +1743,7 @@ GST_TAG_CAPTURING_SOURCE
|
||||||
GST_TAG_CAPTURING_EXPOSURE_COMPENSATION
|
GST_TAG_CAPTURING_EXPOSURE_COMPENSATION
|
||||||
GST_TAG_IMAGE_HORIZONTAL_PPI
|
GST_TAG_IMAGE_HORIZONTAL_PPI
|
||||||
GST_TAG_IMAGE_VERTICAL_PPI
|
GST_TAG_IMAGE_VERTICAL_PPI
|
||||||
|
GST_TAG_ID3V2_HEADER_SIZE
|
||||||
gst_tag_register_musicbrainz_tags
|
gst_tag_register_musicbrainz_tags
|
||||||
gst_tag_freeform_string_to_utf8
|
gst_tag_freeform_string_to_utf8
|
||||||
gst_tag_parse_extended_comment
|
gst_tag_parse_extended_comment
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
* SECTION:gstaudiofilter
|
* SECTION:gstaudiofilter
|
||||||
* @short_description: Base class for simple audio filters
|
* @short_description: Base class for simple audio filters
|
||||||
*
|
*
|
||||||
* #GstAudioFilter is a #GstBaseTransform-derived base class for simple audio
|
* #GstAudioFilter is a #GstBaseTransform<!-- -->-derived base class for simple audio
|
||||||
* filters, ie. those that output the same format that they get as input.
|
* filters, ie. those that output the same format that they get as input.
|
||||||
*
|
*
|
||||||
* #GstAudioFilter will parse the input format for you (with error checking)
|
* #GstAudioFilter will parse the input format for you (with error checking)
|
||||||
|
|
|
@ -142,8 +142,8 @@ gst_color_balance_list_channels (GstColorBalance * balance)
|
||||||
* Sets the current value of the channel to the passed value, which must
|
* Sets the current value of the channel to the passed value, which must
|
||||||
* be between min_value and max_value.
|
* be between min_value and max_value.
|
||||||
*
|
*
|
||||||
* See Also: The #GstColorBalanceChannel::min_value and
|
* See Also: The #GstColorBalanceChannel.min_value and
|
||||||
* #GstColorBalanceChannel::max_value members of the
|
* #GstColorBalanceChannel.max_value members of the
|
||||||
* #GstColorBalanceChannel object.
|
* #GstColorBalanceChannel object.
|
||||||
*/
|
*/
|
||||||
void
|
void
|
||||||
|
@ -165,8 +165,8 @@ gst_color_balance_set_value (GstColorBalance * balance,
|
||||||
* Retrieve the current value of the indicated channel, between min_value
|
* Retrieve the current value of the indicated channel, between min_value
|
||||||
* and max_value.
|
* and max_value.
|
||||||
*
|
*
|
||||||
* See Also: The #GstColorBalanceChannel::min_value and
|
* See Also: The #GstColorBalanceChannel.min_value and
|
||||||
* #GstColorBalanceChannel::max_value members of the
|
* #GstColorBalanceChannel.max_value members of the
|
||||||
* #GstColorBalanceChannel object.
|
* #GstColorBalanceChannel object.
|
||||||
*
|
*
|
||||||
* Returns: The current value of the channel.
|
* Returns: The current value of the channel.
|
||||||
|
|
|
@ -544,7 +544,7 @@ gst_mixer_option_changed (GstMixer * mixer,
|
||||||
* options of a given options object has changed.
|
* options of a given options object has changed.
|
||||||
*
|
*
|
||||||
* The new options are not contained in the message on purpose. Applications
|
* The new options are not contained in the message on purpose. Applications
|
||||||
* should call gst_mixer_option_get_values() on @opts to make @opts update
|
* should call gst_mixer_options_get_values() on @opts to make @opts update
|
||||||
* its internal state and obtain the new list of values.
|
* its internal state and obtain the new list of values.
|
||||||
*
|
*
|
||||||
* This function only works for GstElements that are implementing the
|
* This function only works for GstElements that are implementing the
|
||||||
|
|
|
@ -486,7 +486,7 @@ gst_navigation_query_parse_angles (GstQuery * query, guint * cur_angle,
|
||||||
* Check a bus message to see if it is a #GstNavigation event, and return
|
* Check a bus message to see if it is a #GstNavigation event, and return
|
||||||
* the #GstNavigationMessageType identifying the type of the message if so.
|
* the #GstNavigationMessageType identifying the type of the message if so.
|
||||||
*
|
*
|
||||||
* Returns: The type of the #GstNavigationMessage, or
|
* Returns: The type of the #GstMessage, or
|
||||||
* #GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
|
* #GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
|
||||||
* notification.
|
* notification.
|
||||||
*
|
*
|
||||||
|
|
|
@ -53,7 +53,7 @@ struct _GstStreamVolumeInterface {
|
||||||
* @GST_STREAM_VOLUME_FORMAT_CUBIC: Cubic volume scale
|
* @GST_STREAM_VOLUME_FORMAT_CUBIC: Cubic volume scale
|
||||||
* @GST_STREAM_VOLUME_FORMAT_DB: Logarithmic volume scale (dB, amplitude not power)
|
* @GST_STREAM_VOLUME_FORMAT_DB: Logarithmic volume scale (dB, amplitude not power)
|
||||||
*
|
*
|
||||||
* Different representations of a stream volume. gst_stream_volume_convert()
|
* Different representations of a stream volume. gst_stream_volume_convert_volume()
|
||||||
* allows to convert between the different representations.
|
* allows to convert between the different representations.
|
||||||
*
|
*
|
||||||
* Formulas to convert from a linear to a cubic or dB volume are
|
* Formulas to convert from a linear to a cubic or dB volume are
|
||||||
|
|
|
@ -399,7 +399,7 @@ gst_x_overlay_set_window_handle (GstXOverlay * overlay, guintptr handle)
|
||||||
/**
|
/**
|
||||||
* gst_x_overlay_got_xwindow_id:
|
* gst_x_overlay_got_xwindow_id:
|
||||||
* @overlay: a #GstXOverlay which got a XWindow.
|
* @overlay: a #GstXOverlay which got a XWindow.
|
||||||
* @xwindow_id: a #XID referencing the XWindow.
|
* @xwindow_id: a XID referencing the XWindow.
|
||||||
*
|
*
|
||||||
* This will post a "have-xwindow-id" element message on the bus.
|
* This will post a "have-xwindow-id" element message on the bus.
|
||||||
*
|
*
|
||||||
|
|
|
@ -934,7 +934,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (misc, const GstStructure *, NULL);
|
||||||
* gst_discoverer_info_get_tags:
|
* gst_discoverer_info_get_tags:
|
||||||
* @info: a #GstDiscovererInfo
|
* @info: a #GstDiscovererInfo
|
||||||
*
|
*
|
||||||
* Returns: (transfer none): all tags contained in the %URI. If you wish to use
|
* Returns: (transfer none): all tags contained in the URI. If you wish to use
|
||||||
* the tags after the life-time of @info, you will need to copy them.
|
* the tags after the life-time of @info, you will need to copy them.
|
||||||
*
|
*
|
||||||
* Since: 0.10.31
|
* Since: 0.10.31
|
||||||
|
|
|
@ -58,7 +58,7 @@ G_BEGIN_DECLS
|
||||||
*
|
*
|
||||||
* Result codes returned by gst_install_plugins_async() and
|
* Result codes returned by gst_install_plugins_async() and
|
||||||
* gst_install_plugins_sync(), and also the result code passed to the
|
* gst_install_plugins_sync(), and also the result code passed to the
|
||||||
* #GstInstallPluginsResultFunc specified with gst_install_plugin_async().
|
* #GstInstallPluginsResultFunc specified with gst_install_plugins_async().
|
||||||
*
|
*
|
||||||
* These codes indicate success or failure of starting an external installer
|
* These codes indicate success or failure of starting an external installer
|
||||||
* program and to what extent the requested plugins could be installed.
|
* program and to what extent the requested plugins could be installed.
|
||||||
|
|
|
@ -284,7 +284,7 @@ gst_rtp_buffer_calc_payload_len (guint packet_len, guint8 pad_len,
|
||||||
- pad_len;
|
- pad_len;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*
|
||||||
* validate_data:
|
* validate_data:
|
||||||
* @data: the data to validate
|
* @data: the data to validate
|
||||||
* @len: the length of @data to validate
|
* @len: the length of @data to validate
|
||||||
|
@ -401,7 +401,7 @@ gst_rtp_buffer_validate_data (guint8 * data, guint len)
|
||||||
* @buffer: the buffer to validate
|
* @buffer: the buffer to validate
|
||||||
*
|
*
|
||||||
* Check if the data pointed to by @buffer is a valid RTP packet using
|
* Check if the data pointed to by @buffer is a valid RTP packet using
|
||||||
* validate_data().
|
* gst_rtp_buffer_validate_data().
|
||||||
* Use this function to validate a packet before using the other functions in
|
* Use this function to validate a packet before using the other functions in
|
||||||
* this module.
|
* this module.
|
||||||
*
|
*
|
||||||
|
@ -425,7 +425,7 @@ gst_rtp_buffer_validate (GstBuffer * buffer)
|
||||||
* gst_rtp_buffer_list_validate:
|
* gst_rtp_buffer_list_validate:
|
||||||
* @list: the buffer list to validate
|
* @list: the buffer list to validate
|
||||||
*
|
*
|
||||||
* Check if all RTP packets in the @list are valid using validate_data().
|
* Check if all RTP packets in the @list are valid using gst_rtp_buffer_validate_data().
|
||||||
* Use this function to validate an list before using the other functions in
|
* Use this function to validate an list before using the other functions in
|
||||||
* this module.
|
* this module.
|
||||||
*
|
*
|
||||||
|
|
|
@ -231,8 +231,7 @@ gst_rtsp_transport_get_mime (GstRTSPTransMode trans, const gchar ** mime)
|
||||||
* @manager: location to hold the result
|
* @manager: location to hold the result
|
||||||
* @option: option index.
|
* @option: option index.
|
||||||
*
|
*
|
||||||
* Get the #GStreamer element that can handle the buffers transported over
|
* Get the #GstElement that can handle the buffers transported over @trans.
|
||||||
* @trans.
|
|
||||||
*
|
*
|
||||||
* It is possible that there are several managers available, use @option to
|
* It is possible that there are several managers available, use @option to
|
||||||
* selected one.
|
* selected one.
|
||||||
|
|
|
@ -385,10 +385,10 @@ unescape_path_component (gchar * comp)
|
||||||
* Splits the path of @url on '/' boundaries, decoding the resulting components,
|
* Splits the path of @url on '/' boundaries, decoding the resulting components,
|
||||||
*
|
*
|
||||||
* The decoding performed by this routine is "URI decoding", as defined in RFC
|
* The decoding performed by this routine is "URI decoding", as defined in RFC
|
||||||
* 3986, commonly known as percent-decoding. For example, a string "foo%2fbar"
|
* 3986, commonly known as percent-decoding. For example, a string "foo\%2fbar"
|
||||||
* will decode to "foo/bar" -- the %2f being replaced by the corresponding byte
|
* will decode to "foo/bar" -- the \%2f being replaced by the corresponding byte
|
||||||
* with hex value 0x2f. Note that there is no guarantee that the resulting byte
|
* with hex value 0x2f. Note that there is no guarantee that the resulting byte
|
||||||
* sequence is valid in any given encoding. As a special case, %00 is not
|
* sequence is valid in any given encoding. As a special case, \%00 is not
|
||||||
* unescaped to NUL, as that would prematurely terminate the string.
|
* unescaped to NUL, as that would prematurely terminate the string.
|
||||||
*
|
*
|
||||||
* Also note that since paths usually start with a slash, the first component
|
* Also note that since paths usually start with a slash, the first component
|
||||||
|
|
|
@ -1204,7 +1204,7 @@ DEFINE_ARRAY_GETTER (media, medias, const GstSDPMedia);
|
||||||
*
|
*
|
||||||
* Adds @media to the array of medias in @msg. This function takes ownership of
|
* Adds @media to the array of medias in @msg. This function takes ownership of
|
||||||
* the contents of @media so that @media will have to be reinitialized with
|
* the contents of @media so that @media will have to be reinitialized with
|
||||||
* gst_media_init() before it can be used again.
|
* gst_sdp_media_init() before it can be used again.
|
||||||
*
|
*
|
||||||
* Returns: a #GstSDPResult.
|
* Returns: a #GstSDPResult.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -105,10 +105,10 @@ struct _GstVideoSink {
|
||||||
/**
|
/**
|
||||||
* GstVideoSinkClass:
|
* GstVideoSinkClass:
|
||||||
* @parent_class: the parent class structure
|
* @parent_class: the parent class structure
|
||||||
* @show_frame: render a video frame. Maps to #GstBaseSink::render and
|
* @show_frame: render a video frame. Maps to #GstBaseSinkClass.render() and
|
||||||
* #GstBaseSink::preroll vfuncs. Rendering during preroll will be
|
* #GstBaseSinkClass.preroll() vfuncs. Rendering during preroll will be
|
||||||
* suppressed if the 'show-preroll-frame' property is set to #FALSE.
|
* suppressed if the GstVideoSink::show-preroll-frame property is set to
|
||||||
* Since: 0.10.25
|
* %FALSE. Since: 0.10.25
|
||||||
*
|
*
|
||||||
* The video sink class structure. Derived classes should override the
|
* The video sink class structure. Derived classes should override the
|
||||||
* @show_frame virtual function.
|
* @show_frame virtual function.
|
||||||
|
|
Loading…
Reference in a new issue