[gst-devel] gsttag.h defines && docs

[Benjamin Otte]

On Thu, 6 Jan 2005, Stefan Kost wrote:

> hi hi,
>
> another one in gsttag.h we have about 30 defines for tag name constants that all
> have quite obvious names. IMHO these do not really need docs, so I can tell
> gtkdoc that. Docs like "the media title", "the creator of the media" are not so
> helpful.
> On the otherhand there a re a feew, where an example might be helpful. E.g.
> GST_TAG_BITRATE: is that just an integer or a string like "128 kBit".
>
> @Company - what do think?
>
I'd like to have docs for them, even if it's just "title of the stream",
just because there are less obvious ones and you might want to add
clarification for some tags (like what the difference between artist,
composer, producer and lyricist is - or the difference between nominal,
minimum, maximum and average bitrate). It'd probably also be useful to
document the type of the tag (the date tag being a uint describing
the julian day for example isn't obvious).

For a start I'd just extract the simple descriptions from the
gst_tag_register's in gsttag.c.

Benjamin