From 01bbdd6bdf7f1a8814c061dd6ba1e1204b6fe6fd Mon Sep 17 00:00:00 2001 From: Stefan Kost Date: Sat, 20 Aug 2011 19:16:42 +0200 Subject: [PATCH] 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.. --- docs/libs/gst-plugins-base-libs-docs.sgml | 1 + docs/libs/gst-plugins-base-libs-sections.txt | 1 + gst-libs/gst/audio/gstaudiofilter.c | 2 +- gst-libs/gst/interfaces/colorbalance.c | 8 ++++---- gst-libs/gst/interfaces/mixer.c | 2 +- gst-libs/gst/interfaces/navigation.c | 2 +- gst-libs/gst/interfaces/streamvolume.h | 2 +- gst-libs/gst/interfaces/xoverlay.c | 2 +- gst-libs/gst/pbutils/gstdiscoverer-types.c | 2 +- gst-libs/gst/pbutils/install-plugins.h | 2 +- gst-libs/gst/rtp/gstrtpbuffer.c | 6 +++--- gst-libs/gst/rtsp/gstrtsptransport.c | 3 +-- gst-libs/gst/rtsp/gstrtspurl.c | 6 +++--- gst-libs/gst/sdp/gstsdpmessage.c | 2 +- gst-libs/gst/video/gstvideosink.h | 8 ++++---- 15 files changed, 25 insertions(+), 24 deletions(-) diff --git a/docs/libs/gst-plugins-base-libs-docs.sgml b/docs/libs/gst-plugins-base-libs-docs.sgml index 605930cbb1..65677efb94 100644 --- a/docs/libs/gst-plugins-base-libs-docs.sgml +++ b/docs/libs/gst-plugins-base-libs-docs.sgml @@ -188,6 +188,7 @@ + diff --git a/docs/libs/gst-plugins-base-libs-sections.txt b/docs/libs/gst-plugins-base-libs-sections.txt index 42f5d78a93..2f050a6f49 100644 --- a/docs/libs/gst-plugins-base-libs-sections.txt +++ b/docs/libs/gst-plugins-base-libs-sections.txt @@ -1743,6 +1743,7 @@ GST_TAG_CAPTURING_SOURCE GST_TAG_CAPTURING_EXPOSURE_COMPENSATION GST_TAG_IMAGE_HORIZONTAL_PPI GST_TAG_IMAGE_VERTICAL_PPI +GST_TAG_ID3V2_HEADER_SIZE gst_tag_register_musicbrainz_tags gst_tag_freeform_string_to_utf8 gst_tag_parse_extended_comment diff --git a/gst-libs/gst/audio/gstaudiofilter.c b/gst-libs/gst/audio/gstaudiofilter.c index ca928d6e8b..fcdf725941 100644 --- a/gst-libs/gst/audio/gstaudiofilter.c +++ b/gst-libs/gst/audio/gstaudiofilter.c @@ -23,7 +23,7 @@ * SECTION:gstaudiofilter * @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. * * #GstAudioFilter will parse the input format for you (with error checking) diff --git a/gst-libs/gst/interfaces/colorbalance.c b/gst-libs/gst/interfaces/colorbalance.c index 319c1b9247..60268acae3 100644 --- a/gst-libs/gst/interfaces/colorbalance.c +++ b/gst-libs/gst/interfaces/colorbalance.c @@ -142,8 +142,8 @@ gst_color_balance_list_channels (GstColorBalance * balance) * Sets the current value of the channel to the passed value, which must * be between min_value and max_value. * - * See Also: The #GstColorBalanceChannel::min_value and - * #GstColorBalanceChannel::max_value members of the + * See Also: The #GstColorBalanceChannel.min_value and + * #GstColorBalanceChannel.max_value members of the * #GstColorBalanceChannel object. */ void @@ -165,8 +165,8 @@ gst_color_balance_set_value (GstColorBalance * balance, * Retrieve the current value of the indicated channel, between min_value * and max_value. * - * See Also: The #GstColorBalanceChannel::min_value and - * #GstColorBalanceChannel::max_value members of the + * See Also: The #GstColorBalanceChannel.min_value and + * #GstColorBalanceChannel.max_value members of the * #GstColorBalanceChannel object. * * Returns: The current value of the channel. diff --git a/gst-libs/gst/interfaces/mixer.c b/gst-libs/gst/interfaces/mixer.c index 8117d2081a..0c6abf0960 100644 --- a/gst-libs/gst/interfaces/mixer.c +++ b/gst-libs/gst/interfaces/mixer.c @@ -544,7 +544,7 @@ gst_mixer_option_changed (GstMixer * mixer, * options of a given options object has changed. * * 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. * * This function only works for GstElements that are implementing the diff --git a/gst-libs/gst/interfaces/navigation.c b/gst-libs/gst/interfaces/navigation.c index 7203ce8ef9..2df4a7bafe 100644 --- a/gst-libs/gst/interfaces/navigation.c +++ b/gst-libs/gst/interfaces/navigation.c @@ -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 * 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 * notification. * diff --git a/gst-libs/gst/interfaces/streamvolume.h b/gst-libs/gst/interfaces/streamvolume.h index ea47ab6163..3a082ed089 100644 --- a/gst-libs/gst/interfaces/streamvolume.h +++ b/gst-libs/gst/interfaces/streamvolume.h @@ -53,7 +53,7 @@ struct _GstStreamVolumeInterface { * @GST_STREAM_VOLUME_FORMAT_CUBIC: Cubic volume scale * @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. * * Formulas to convert from a linear to a cubic or dB volume are diff --git a/gst-libs/gst/interfaces/xoverlay.c b/gst-libs/gst/interfaces/xoverlay.c index 6fcb5ccad0..8e7ef07a86 100644 --- a/gst-libs/gst/interfaces/xoverlay.c +++ b/gst-libs/gst/interfaces/xoverlay.c @@ -399,7 +399,7 @@ gst_x_overlay_set_window_handle (GstXOverlay * overlay, guintptr handle) /** * gst_x_overlay_got_xwindow_id: * @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. * diff --git a/gst-libs/gst/pbutils/gstdiscoverer-types.c b/gst-libs/gst/pbutils/gstdiscoverer-types.c index 2edf8e923c..6949c804ff 100644 --- a/gst-libs/gst/pbutils/gstdiscoverer-types.c +++ b/gst-libs/gst/pbutils/gstdiscoverer-types.c @@ -934,7 +934,7 @@ DISCOVERER_INFO_ACCESSOR_CODE (misc, const GstStructure *, NULL); * gst_discoverer_info_get_tags: * @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. * * Since: 0.10.31 diff --git a/gst-libs/gst/pbutils/install-plugins.h b/gst-libs/gst/pbutils/install-plugins.h index e57d8ac543..f3ec2c0adc 100644 --- a/gst-libs/gst/pbutils/install-plugins.h +++ b/gst-libs/gst/pbutils/install-plugins.h @@ -58,7 +58,7 @@ G_BEGIN_DECLS * * Result codes returned by gst_install_plugins_async() and * 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 * program and to what extent the requested plugins could be installed. diff --git a/gst-libs/gst/rtp/gstrtpbuffer.c b/gst-libs/gst/rtp/gstrtpbuffer.c index 141b072364..d99f6462e9 100644 --- a/gst-libs/gst/rtp/gstrtpbuffer.c +++ b/gst-libs/gst/rtp/gstrtpbuffer.c @@ -284,7 +284,7 @@ gst_rtp_buffer_calc_payload_len (guint packet_len, guint8 pad_len, - pad_len; } -/** +/* * validate_data: * @data: the 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 * * 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 * this module. * @@ -425,7 +425,7 @@ gst_rtp_buffer_validate (GstBuffer * buffer) * gst_rtp_buffer_list_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 * this module. * diff --git a/gst-libs/gst/rtsp/gstrtsptransport.c b/gst-libs/gst/rtsp/gstrtsptransport.c index de3085ed31..ab834a5016 100644 --- a/gst-libs/gst/rtsp/gstrtsptransport.c +++ b/gst-libs/gst/rtsp/gstrtsptransport.c @@ -231,8 +231,7 @@ gst_rtsp_transport_get_mime (GstRTSPTransMode trans, const gchar ** mime) * @manager: location to hold the result * @option: option index. * - * Get the #GStreamer element that can handle the buffers transported over - * @trans. + * Get the #GstElement that can handle the buffers transported over @trans. * * It is possible that there are several managers available, use @option to * selected one. diff --git a/gst-libs/gst/rtsp/gstrtspurl.c b/gst-libs/gst/rtsp/gstrtspurl.c index 6973e09c38..db2637c8ea 100644 --- a/gst-libs/gst/rtsp/gstrtspurl.c +++ b/gst-libs/gst/rtsp/gstrtspurl.c @@ -385,10 +385,10 @@ unescape_path_component (gchar * comp) * Splits the path of @url on '/' boundaries, decoding the resulting components, * * 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" - * will decode to "foo/bar" -- the %2f being replaced by the corresponding byte + * 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 * 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. * * Also note that since paths usually start with a slash, the first component diff --git a/gst-libs/gst/sdp/gstsdpmessage.c b/gst-libs/gst/sdp/gstsdpmessage.c index 7d2813a979..cd95c7cad8 100644 --- a/gst-libs/gst/sdp/gstsdpmessage.c +++ b/gst-libs/gst/sdp/gstsdpmessage.c @@ -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 * 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. */ diff --git a/gst-libs/gst/video/gstvideosink.h b/gst-libs/gst/video/gstvideosink.h index f53459e6e8..e787a16ea8 100644 --- a/gst-libs/gst/video/gstvideosink.h +++ b/gst-libs/gst/video/gstvideosink.h @@ -105,10 +105,10 @@ struct _GstVideoSink { /** * GstVideoSinkClass: * @parent_class: the parent class structure - * @show_frame: render a video frame. Maps to #GstBaseSink::render and - * #GstBaseSink::preroll vfuncs. Rendering during preroll will be - * suppressed if the 'show-preroll-frame' property is set to #FALSE. - * Since: 0.10.25 + * @show_frame: render a video frame. Maps to #GstBaseSinkClass.render() and + * #GstBaseSinkClass.preroll() vfuncs. Rendering during preroll will be + * suppressed if the GstVideoSink::show-preroll-frame property is set to + * %FALSE. Since: 0.10.25 * * The video sink class structure. Derived classes should override the * @show_frame virtual function.