summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim.muller@collabora.co.uk>2010-01-06 20:06:47 +0000
committerTim-Philipp Müller <tim.muller@collabora.co.uk>2010-01-06 20:06:47 +0000
commit1474e7a9fa4f52d32e3edf6fc8f413a3273939f0 (patch)
tree9b17ab96c12813b3233a403db78a372812518faf
parent27fd0b8d9c7ed4697821487a5543bbea3bd0e30b (diff)
docs: minor documentation fixes for recently-added tags
Mention the type of the tag in the gtk-doc blurb, so people know which accessor API to use, and fix up the doc blurbs to match the actual tag define.
-rw-r--r--gst/gsttaglist.h23
1 files changed, 12 insertions, 11 deletions
diff --git a/gst/gsttaglist.h b/gst/gsttaglist.h
index 2ec2778000..285aadd1be 100644
--- a/gst/gsttaglist.h
+++ b/gst/gsttaglist.h
@@ -791,33 +791,33 @@ gboolean gst_tag_list_get_buffer_index (const GstTagList * list,
*/
#define GST_TAG_GEO_LOCATION_ELEVATION "geo-location-elevation"
/**
- * GST_TAG_TV_SHOW
+ * GST_TAG_SHOW_NAME
*
- * Name of the show of the media, used for displaying
+ * Name of the show, used for displaying (string)
*
* Since: 0.10.26
*/
#define GST_TAG_SHOW_NAME "show-name"
/**
- * GST_TAG_TV_SHOW_SORTNAME
+ * GST_TAG_SHOW_SORTNAME
*
- * Name of the show of the media, used for sorting
+ * Name of the show, used for sorting (string)
*
* Since: 0.10.26
*/
#define GST_TAG_SHOW_SORTNAME "show-sortname"
/**
- * GST_TAG_EPISODE_NUMBER
+ * GST_TAG_SHOW_EPISODE_NUMBER
*
- * Number of the episode within a season/show
+ * Number of the episode within a season/show (unsigned integer)
*
* Since: 0.10.26
*/
#define GST_TAG_SHOW_EPISODE_NUMBER "show-episode-number"
/**
- * GST_TAG_SEASON_NUMBER
+ * GST_TAG_SHOW_SEASON_NUMBER
*
- * Number of the season of a show/series
+ * Number of the season of a show/series (unsigned integer)
*
* Since: 0.10.26
*/
@@ -825,7 +825,7 @@ gboolean gst_tag_list_get_buffer_index (const GstTagList * list,
/**
* GST_TAG_LYRICS
*
- * The lyrics of the media
+ * The lyrics of the media (string)
*
* Since: 0.10.26
*/
@@ -833,7 +833,7 @@ gboolean gst_tag_list_get_buffer_index (const GstTagList * list,
/**
* GST_TAG_COMPOSER_SORTNAME
*
- * The composer's name, used for sorting
+ * The composer's name, used for sorting (string)
*
* Since: 0.10.26
*/
@@ -842,11 +842,12 @@ gboolean gst_tag_list_get_buffer_index (const GstTagList * list,
* GST_TAG_GROUPING
*
* Groups together media that are related and spans multiple tracks. An
- * example are multiple pieces of a concerto.
+ * example are multiple pieces of a concerto. (string)
*
* Since: 0.10.26
*/
#define GST_TAG_GROUPING "grouping"
+
G_END_DECLS
#endif /* __GST_TAGLIST_H__ */