gst/gsttaginterface.c: Some documentation fixes (#307394 and #307397).

Original commit message from CVS:
Reviewed by:  Ronald S. Bultje  <rbultje@ronald.bitfreak.net>
* gst/gsttaginterface.c:
Some documentation fixes (#307394 and #307397).
This commit is contained in:
Ronald S. Bultje 2005-06-30 10:59:34 +00:00
parent 2f2a020111
commit 6c8dc39ee4
3 changed files with 21 additions and 14 deletions

View file

@ -1,3 +1,10 @@
2005-06-30 Torsten Schoenfeld <kaffeetisch@gmx.de>
Reviewed by: Ronald S. Bultje <rbultje@ronald.bitfreak.net>
* gst/gsttaginterface.c:
Some documentation fixes (#307394 and #307397).
2005-06-30 Antoine Tremblay <hexa00@gmail.com> 2005-06-30 Antoine Tremblay <hexa00@gmail.com>
Reviewed by: Ronald S. Bultje <rbultje@ronald.bitfreak.net> Reviewed by: Ronald S. Bultje <rbultje@ronald.bitfreak.net>

View file

@ -132,7 +132,7 @@ gst_tag_setter_merge (GstTagSetter * setter, const GstTagList * list,
* @...: more tag / value pairs to set * @...: more tag / value pairs to set
* *
* Adds the given tag / value pairs on the setter using the given merge mode. * Adds the given tag / value pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode,
@ -156,7 +156,7 @@ gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode,
* @...: more tag / GValue pairs to set * @...: more tag / GValue pairs to set
* *
* Adds the given tag / GValue pairs on the setter using the given merge mode. * Adds the given tag / GValue pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode,
@ -180,7 +180,7 @@ gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / value pairs to set * @var_args: tag / value pairs to set
* *
* Adds the given tag / value pairs on the setter using the given merge mode. * Adds the given tag / value pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode,
@ -206,7 +206,7 @@ gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / GValue pairs to set * @var_args: tag / GValue pairs to set
* *
* Adds the given tag / GValue pairs on the setter using the given merge mode. * Adds the given tag / GValue pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode,
@ -228,13 +228,13 @@ gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode,
* gst_tag_setter_get_list: * gst_tag_setter_get_list:
* @setter: a #GstTagSetter * @setter: a #GstTagSetter
* *
* Retrieves a copy of the current list of tags the setter uses. * Returns the current list of tags the setter uses. The list should not be
* You need to gst_tag_list_free() the list after use. * modified or freed.
* *
* Returns: a current snapshot of the taglist used in the setter * Returns: a current snapshot of the taglist used in the setter
* or NULL if none is used. * or NULL if none is used.
*/ */
const GstTagList * G_CONST_RETURN GstTagList *
gst_tag_setter_get_list (GstTagSetter * setter) gst_tag_setter_get_list (GstTagSetter * setter)
{ {
g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL); g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL);

View file

@ -132,7 +132,7 @@ gst_tag_setter_merge (GstTagSetter * setter, const GstTagList * list,
* @...: more tag / value pairs to set * @...: more tag / value pairs to set
* *
* Adds the given tag / value pairs on the setter using the given merge mode. * Adds the given tag / value pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode,
@ -156,7 +156,7 @@ gst_tag_setter_add (GstTagSetter * setter, GstTagMergeMode mode,
* @...: more tag / GValue pairs to set * @...: more tag / GValue pairs to set
* *
* Adds the given tag / GValue pairs on the setter using the given merge mode. * Adds the given tag / GValue pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode,
@ -180,7 +180,7 @@ gst_tag_setter_add_values (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / value pairs to set * @var_args: tag / value pairs to set
* *
* Adds the given tag / value pairs on the setter using the given merge mode. * Adds the given tag / value pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode,
@ -206,7 +206,7 @@ gst_tag_setter_add_valist (GstTagSetter * setter, GstTagMergeMode mode,
* @var_args: tag / GValue pairs to set * @var_args: tag / GValue pairs to set
* *
* Adds the given tag / GValue pairs on the setter using the given merge mode. * Adds the given tag / GValue pairs on the setter using the given merge mode.
* The list must be terminated with GST_TAG_INVALID. * The list must be terminated with NULL.
*/ */
void void
gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode, gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode,
@ -228,13 +228,13 @@ gst_tag_setter_add_valist_values (GstTagSetter * setter, GstTagMergeMode mode,
* gst_tag_setter_get_list: * gst_tag_setter_get_list:
* @setter: a #GstTagSetter * @setter: a #GstTagSetter
* *
* Retrieves a copy of the current list of tags the setter uses. * Returns the current list of tags the setter uses. The list should not be
* You need to gst_tag_list_free() the list after use. * modified or freed.
* *
* Returns: a current snapshot of the taglist used in the setter * Returns: a current snapshot of the taglist used in the setter
* or NULL if none is used. * or NULL if none is used.
*/ */
const GstTagList * G_CONST_RETURN GstTagList *
gst_tag_setter_get_list (GstTagSetter * setter) gst_tag_setter_get_list (GstTagSetter * setter)
{ {
g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL); g_return_val_if_fail (GST_IS_TAG_SETTER (setter), NULL);