gst-libs/gst/: Make gtk-doc happy.

Original commit message from CVS:
* gst-libs/gst/interfaces/propertyprobe.c:
* gst-libs/gst/rtp/gstbasertpaudiopayload.c:
* gst-libs/gst/tag/gstvorbistag.c:
Make gtk-doc happy.
This commit is contained in:
Stefan Kost 2007-07-10 20:46:41 +00:00
parent 8a499651b9
commit aac0353ce6
4 changed files with 15 additions and 12 deletions

View File

@ -1,3 +1,10 @@
2007-07-10 Stefan Kost <ensonic@users.sf.net>
* gst-libs/gst/interfaces/propertyprobe.c:
* gst-libs/gst/rtp/gstbasertpaudiopayload.c:
* gst-libs/gst/tag/gstvorbistag.c:
Make gtk-doc happy.
2007-07-08 Tim-Philipp Müller <tim at centricular dot net> 2007-07-08 Tim-Philipp Müller <tim at centricular dot net>
* gst-libs/gst/audio/gstbaseaudiosink.c: * gst-libs/gst/audio/gstbaseaudiosink.c:

View File

@ -88,7 +88,7 @@ gst_property_probe_iface_init (GstPropertyProbeInterface * iface)
* *
* Get a list of properties for which probing is supported. * Get a list of properties for which probing is supported.
* *
* Returns the list of properties for which probing is supported * Returns: the list of properties for which probing is supported
* by this element. * by this element.
*/ */
@ -147,11 +147,7 @@ gst_property_probe_probe_property (GstPropertyProbe * probe,
* @probe: the #GstPropertyProbe to check. * @probe: the #GstPropertyProbe to check.
* @name: name of the property to return. * @name: name of the property to return.
* *
* Returns the #GParamSpec for the given property. It's similar to * Runs a probe on the given property.
* g_object_class_find_property (), except that this function only
* takes "probe'able" properties into account.
*
* Returns: the #GParamSpec that belongs to the given property.
*/ */
void void

View File

@ -552,7 +552,7 @@ gst_base_rtp_audio_payload_handle_sample_based_buffer (GstBaseRTPPayload *
/** /**
* gst_base_rtp_audio_payload_push: * gst_base_rtp_audio_payload_push:
* @basepayload: a #GstBaseRTPPayload * @baseaudiopayload: a #GstBaseRTPPayload
* @data: data to set as payload * @data: data to set as payload
* @payload_len: length of payload * @payload_len: length of payload
* @timestamp: a #GstClockTime * @timestamp: a #GstClockTime

View File

@ -24,7 +24,7 @@
* @short_description: tag mappings and support functions for plugins * @short_description: tag mappings and support functions for plugins
* dealing with vorbiscomments * dealing with vorbiscomments
* @see_also: #GstTagList * @see_also: #GstTagList
* *
* <refsect2> * <refsect2>
* <para> * <para>
* Contains various utility functions for plugins to parse or create * Contains various utility functions for plugins to parse or create
@ -145,7 +145,7 @@ gst_tag_to_vorbis_tag (const gchar * gst_tag)
* gst_vorbis_tag_add: * gst_vorbis_tag_add:
* @list: a #GstTagList * @list: a #GstTagList
* @tag: a vorbiscomment tag string (key in key=value), must be valid UTF-8 * @tag: a vorbiscomment tag string (key in key=value), must be valid UTF-8
* @val: a vorbiscomment value string (value in key=value), must be valid UTF-8 * @value: a vorbiscomment value string (value in key=value), must be valid UTF-8
* *
* Convenience function using gst_tag_from_vorbis_tag(), parsing * Convenience function using gst_tag_from_vorbis_tag(), parsing
* a vorbis comment string into the right type and adding it to the * a vorbis comment string into the right type and adding it to the
@ -295,10 +295,10 @@ gst_vorbis_tag_add (GstTagList * list, const gchar * tag, const gchar * value)
* @vendor_string: pointer to a string that should take the vendor string * @vendor_string: pointer to a string that should take the vendor string
* of this vorbis comment or NULL if you don't need it. * of this vorbis comment or NULL if you don't need it.
* *
* Creates a new tag list that contains the information parsed out of a * Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet. * vorbiscomment packet.
* *
* Returns: A new #GstTagList with all tags that could be extracted from the * Returns: A new #GstTagList with all tags that could be extracted from the
* given vorbiscomment buffer or NULL on error. * given vorbiscomment buffer or NULL on error.
*/ */
GstTagList * GstTagList *
@ -378,7 +378,7 @@ MyForEach;
* @list: a #GstTagList * @list: a #GstTagList
* @tag: a GStreamer tag identifier, such as #GST_TAG_ARTIST * @tag: a GStreamer tag identifier, such as #GST_TAG_ARTIST
* *
* Creates a new tag list that contains the information parsed out of a * Creates a new tag list that contains the information parsed out of a
* vorbiscomment packet. * vorbiscomment packet.
* *
* Returns: A #GList of newly-allowcated key=value strings. Free with * Returns: A #GList of newly-allowcated key=value strings. Free with