docs/libs/: Add docs for libgstcdda/GstCddaBaseSrc.

Original commit message from CVS:
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
Add docs for libgstcdda/GstCddaBaseSrc.
* gst-libs/gst/interfaces/mixertrack.h:
Do one struct member per line with a semicolon at the end, that way
even gtk-doc might parse it without complaining.
This commit is contained in:
Tim-Philipp Müller 2005-12-28 18:19:25 +00:00
parent d129bea2be
commit 27af2b5ddc
6 changed files with 51 additions and 4 deletions

View file

@ -1,3 +1,15 @@
2005-12-28 Tim-Philipp Müller <tim at centricular dot net>
* docs/libs/Makefile.am:
* docs/libs/gst-plugins-base-libs-docs.sgml:
* docs/libs/gst-plugins-base-libs-sections.txt:
* docs/libs/gst-plugins-base-libs.types:
Add docs for libgstcdda/GstCddaBaseSrc.
* gst-libs/gst/interfaces/mixertrack.h:
Do one struct member per line with a semicolon at the end, that way
even gtk-doc might parse it without complaining.
2005-12-28 Tim-Philipp Müller <tim at centricular dot net>
* configure.ac:

View file

@ -64,7 +64,8 @@ CFILE_GLOB=$(DOC_SOURCE_DIR)/*/*.c
SCANOBJ_DEPS = \
$(top_builddir)/gst-libs/gst/interfaces/libgstinterfaces-@GST_MAJORMINOR@.la \
$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la
$(top_builddir)/gst-libs/gst/audio/libgstaudio-@GST_MAJORMINOR@.la \
$(top_builddir)/gst-libs/gst/cdda/libgstcdda-@GST_MAJORMINOR@.la
# Header files to ignore when scanning.
IGNORE_HFILES =

View file

@ -6,6 +6,7 @@
<!ENTITY GstCompiling SYSTEM "compiling.sgml">
<!ENTITY GstAudio SYSTEM "xml/gstaudio.xml">
<!ENTITY GstCddaBaseSrc SYSTEM "xml/gstcddabasesrc.xml">
<!ENTITY GstVideoSink SYSTEM "xml/gstvideosink.xml">
<!ENTITY GstVideoFilter SYSTEM "xml/gstvideofilter.xml">
<!ENTITY GstColorBalance SYSTEM "xml/gstcolorbalance.xml">
@ -65,6 +66,17 @@ This library should be linked to by getting cflags and libs from
&GstXOverlay;
</chapter>
<chapter id="gstreamer-cdda">
<title>CDDA Library</title>
<para>
This library should be linked to by getting cflags and libs from
<filename>gstreamer-plugins-base.pc</filename> and adding
<filename>-lgstcdda-&GST_MAJORMINOR;</filename> to the library flags.
</para>
&GstCddaBaseSrc;
</chapter>
<chapter id="gstreamer-gconf">
<title>GConf Library</title>
<para>

View file

@ -9,6 +9,19 @@ gst_audio_is_buffer_framed
gst_audio_structure_set_int
</SECTION>
<SECTION>
<FILE>gstcddabasesrc</FILE>
<INCLUDE>gst/cdda/gstcddabasesrc.h</INCLUDE>
GstCddaBaseSrc
GstCddaBaseSrcTrack
GstCddaBaseSrcMode
gst_cdda_base_src_add_track
GST_TAG_CDDA_CDDB_DISCID
GST_TAG_CDDA_CDDB_DISCID_FULL
GST_TAG_CDDA_MUSICBRAINZ_DISCID
GST_TAG_CDDA_MUSICBRAINZ_DISCID_FULL
</SECTION>
<SECTION>
<FILE>gstcolorbalance</FILE>
<INCLUDE>gst/interfaces/colorbalance.h</INCLUDE>
@ -130,3 +143,9 @@ GstVideoFilterClass
</SECTION>
<SECTION>
<FILE>private</FILE>
sha_init
sha_final
sha_update
</SECTION>

View file

@ -7,3 +7,6 @@ gst_ring_buffer_get_type
gst_color_balance_get_type
gst_color_balance_channel_get_type
#include <gst/cdda/gstcddabasesrc.h>
gst_cdda_base_src_get_type

View file

@ -76,9 +76,9 @@ struct _GstMixerTrack {
gchar *label;
/* FIXME: flags should be guint32. Change in 0.9 */
GstMixerTrackFlags flags;
gint num_channels,
min_volume,
max_volume;
gint num_channels;
gint min_volume;
gint max_volume;
};
struct _GstMixerTrackClass {