Split libgsttag docs into multiple sections.

Original commit message from CVS:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/tag/gstid3tag.c:
* gst-libs/gst/tag/gstvorbistag.c:
* gst-libs/gst/tag/tags.c:
Split libgsttag docs into multiple sections.
This commit is contained in:
Tim-Philipp Müller 2006-02-05 18:22:01 +00:00
parent 8db163abcf
commit 7b43847c2c
6 changed files with 62 additions and 13 deletions

View file

@ -1,3 +1,12 @@
2006-02-05 Tim-Philipp Müller <tim at centricular dot net>
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* gst-libs/gst/tag/gstid3tag.c:
* gst-libs/gst/tag/gstvorbistag.c:
* gst-libs/gst/tag/tags.c:
Split libgsttag docs into multiple sections.
2006-02-05 Tim-Philipp Müller <tim at centricular dot net>
* docs/libs/Makefile.am:

View file

@ -14,6 +14,8 @@
<!ENTITY GstMixer SYSTEM "xml/gstmixer.xml">
<!ENTITY GstRingBuffer SYSTEM "xml/gstringbuffer.xml">
<!ENTITY GstTag SYSTEM "xml/gsttag.xml">
<!ENTITY GstTagVorbis SYSTEM "xml/gsttagvorbis.xml">
<!ENTITY GstTagID3 SYSTEM "xml/gsttagid3.xml">
<!ENTITY GstTuner SYSTEM "xml/gsttuner.xml">
<!ENTITY GstXOverlay SYSTEM "xml/gstxoverlay.xml">
@ -76,6 +78,8 @@ This library should be linked to by getting cflags and libs from
<filename>-lgsttag-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstTag;
&GstTagVorbis;
&GstTagID3;
</chapter>
<chapter id="gstreamer-cdda">

View file

@ -94,6 +94,18 @@ gst_ring_buffer_advance
<SECTION>
<FILE>gsttag</FILE>
<INCLUDE>gst/tag/tag.h</INCLUDE>
GST_TAG_MUSICBRAINZ_TRACKID
GST_TAG_MUSICBRAINZ_ARTISTID
GST_TAG_MUSICBRAINZ_ALBUMID
GST_TAG_MUSICBRAINZ_ALBUMARTISTID
GST_TAG_MUSICBRAINZ_TRMID
GST_TAG_MUSICBRAINZ_SORTNAME
gst_tag_register_musicbrainz_tags
</SECTION>
<SECTION>
<FILE>gsttagvorbis</FILE>
<INCLUDE>gst/tag/tag.h</INCLUDE>
<SUBSECTION>
gst_tag_from_vorbis_tag
gst_tag_to_vorbis_tag
@ -102,20 +114,17 @@ gst_tag_to_vorbis_comments
<SUBSECTION>
gst_tag_list_from_vorbiscomment_buffer
gst_tag_list_to_vorbiscomment_buffer
</SECTION>
<SECTION>
<FILE>gsttagid3</FILE>
<INCLUDE>gst/tag/tag.h</INCLUDE>
<SUBSECTION>
gst_tag_id3_genre_count
gst_tag_id3_genre_get
gst_tag_list_new_from_id3v1
gst_tag_from_id3_tag
gst_tag_to_id3_tag
<SUBSECTION>
GST_TAG_MUSICBRAINZ_TRACKID
GST_TAG_MUSICBRAINZ_ARTISTID
GST_TAG_MUSICBRAINZ_ALBUMID
GST_TAG_MUSICBRAINZ_ALBUMARTISTID
GST_TAG_MUSICBRAINZ_TRMID
GST_TAG_MUSICBRAINZ_SORTNAME
gst_tag_register_musicbrainz_tags
</SECTION>
<SECTION>

View file

@ -19,6 +19,20 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gsttagid3
* @short_description: tag mappings and support functions for plugins
* dealing with ID3v1 and ID3v2 tags
* @see_also: #GstTagList
*
* <refsect2>
* <para>
* Contains various utility functions for plugins to parse or create
* ID3 tags and map ID3v2 identifiers to and from GStreamer identifiers.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

View file

@ -19,6 +19,20 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:gsttagvorbis
* @short_description: tag mappings and support functions for plugins
* dealing with vorbiscomments
* @see_also: #GstTagList
*
* <refsect2>
* <para>
* Contains various utility functions for plugins to parse or create
* vorbiscomments and map them to and from #GstTagList<!-- -->s.
* </para>
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

View file

@ -29,15 +29,14 @@
/**
* SECTION:gsttag
* @short_description: Tag Support Library
* @short_description: additional tag definitions for plugins and applications
* @see_also: #GstTagList
*
* <refsect2>
* <para>
* Contains additional standardized GStreamer tag definitions and
* various utility functions for plugins to parse or create different
* types of tags. Also provides mappings from and to other tag identifiers
* to the GStreamer tag identifier.
* Contains additional standardized GStreamer tag definitions for plugins
* and applications, and functions to register them with the GStreamer
* tag system.
* </para>
* </refsect2>
*/