From 941274f57c9900cbcb6646ebe8f0a243cb5d23df Mon Sep 17 00:00:00 2001
From: Thomas Vander Stichele <thomas@apestaart.org>
Date: Sun, 30 Apr 2006 14:58:29 +0000
Subject: docs/plugins/: Fix up docs for taglib plugin

Original commit message from CVS:

* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-bad-plugins-decl-list.txt:
* docs/plugins/gst-plugins-bad-plugins-decl.txt:
* docs/plugins/gst-plugins-bad-plugins-docs.sgml:
* docs/plugins/gst-plugins-bad-plugins-sections.txt:
* docs/plugins/gst-plugins-bad-plugins-undocumented.txt:
Fix up docs for taglib plugin
Also scan .cc files
---
 docs/plugins/Makefile.am                           |   2 +-
 docs/plugins/gst-plugins-bad-plugins-decl-list.txt |  21 ++--
 docs/plugins/gst-plugins-bad-plugins-decl.txt      | 118 ++++++++-------------
 docs/plugins/gst-plugins-bad-plugins-docs.sgml     |   2 +-
 docs/plugins/gst-plugins-bad-plugins-sections.txt  |   8 +-
 .../gst-plugins-bad-plugins-undocumented.txt       |   9 +-
 6 files changed, 63 insertions(+), 97 deletions(-)

(limited to 'docs/plugins')

diff --git a/docs/plugins/Makefile.am b/docs/plugins/Makefile.am
index 4b623eef..6c6b4c51 100644
--- a/docs/plugins/Makefile.am
+++ b/docs/plugins/Makefile.am
@@ -50,7 +50,7 @@ SCAN_OPTIONS=
 #EXTRA_DIST = gstreamer.types.in gstreamer.hierarchy $(DOC_MODULE)-sections.txt gstreamer-sections.txt $(DOC_MAIN_SGML_FILE)
 
 # Extra options to supply to gtkdoc-mkdb.
-MKDB_OPTIONS=--sgml-mode
+MKDB_OPTIONS=--sgml-mode --source-suffixes=c,h,cc
 
 # Extra options to supply to gtkdoc-fixref.
 # FIXME get the location of the installed gstreamer docs
diff --git a/docs/plugins/gst-plugins-bad-plugins-decl-list.txt b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt
index 98f97a4e..8d3615bf 100644
--- a/docs/plugins/gst-plugins-bad-plugins-decl-list.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-decl-list.txt
@@ -18,23 +18,22 @@ GST_IS_DFBVIDEOSINK_CLASS
 </SECTION>
 
 <SECTION>
-<FILE>ximagesrc</FILE>
-<TITLE>GstXImageSrc</TITLE>
-GstXImageSrc
+<FILE>gstid3v2mux</FILE>
+GstId3v2Mux
+GstId3v2MuxClass
 <SUBSECTION Standard>
-GST_XIMAGESRC
-GST_IS_XIMAGESRC
-GST_TYPE_XIMAGESRC
-gst_ximagesrc_get_type
-GST_XIMAGESRC_CLASS
-GST_IS_XIMAGESRC_CLASS
+GST_ID3V2_MUX
+GST_IS_ID3V2_MUX
+GST_TYPE_ID3V2_MUX
+gst_id3v2_mux_get_type
+GST_ID3V2_MUX_CLASS
+GST_IS_ID3V2_MUX_CLASS
 </SECTION>
 
 <SECTION>
 <FILE>gsttaglib</FILE>
-GstTagLibMuxPriv
-<TITLE>GstTagLibMux</TITLE>
 GstTagLibMux
+GstTagLibMuxClass
 <SUBSECTION Standard>
 GST_TAG_LIB_MUX
 GST_IS_TAG_LIB_MUX
diff --git a/docs/plugins/gst-plugins-bad-plugins-decl.txt b/docs/plugins/gst-plugins-bad-plugins-decl.txt
index ab447584..86ef0ef9 100644
--- a/docs/plugins/gst-plugins-bad-plugins-decl.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-decl.txt
@@ -133,97 +133,62 @@ void
 <RETURNS>GType </RETURNS>
 void
 </FUNCTION>
+<STRUCT>
+<NAME>GstId3v2Mux</NAME>
+</STRUCT>
+<STRUCT>
+<NAME>GstId3v2MuxClass</NAME>
+</STRUCT>
+<STRUCT>
+<NAME></NAME>
+typedef struct _GstId3v2Mux {
+  GstTagLibMux  taglibmux;
+};
+</STRUCT>
+<STRUCT>
+<NAME></NAME>
+typedef struct _GstId3v2MuxClass {
+  GstTagLibMuxClass  taglibmux_class;
+};
+</STRUCT>
 <MACRO>
-<NAME>GST_TYPE_XIMAGESRC</NAME>
-#define GST_TYPE_XIMAGESRC (gst_ximagesrc_get_type())
+<NAME>GST_TYPE_ID3V2_MUX</NAME>
+#define GST_TYPE_ID3V2_MUX \
+  (gst_id3v2_mux_get_type())
 </MACRO>
 <MACRO>
-<NAME>GST_XIMAGESRC</NAME>
-#define GST_XIMAGESRC(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_XIMAGESRC,GstXImageSrc))
+<NAME>GST_ID3V2_MUX</NAME>
+#define GST_ID3V2_MUX(obj) \
+  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_ID3V2_MUX,GstId3v2Mux))
 </MACRO>
 <MACRO>
-<NAME>GST_XIMAGESRC_CLASS</NAME>
-#define GST_XIMAGESRC_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_XIMAGESRC,GstXImageSrc))
+<NAME>GST_ID3V2_MUX_CLASS</NAME>
+#define GST_ID3V2_MUX_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_ID3V2_MUX,GstId3v2MuxClass))
 </MACRO>
 <MACRO>
-<NAME>GST_IS_XIMAGESRC</NAME>
-#define GST_IS_XIMAGESRC(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_XIMAGESRC))
+<NAME>GST_IS_ID3V2_MUX</NAME>
+#define GST_IS_ID3V2_MUX(obj) \
+  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_ID3V2_MUX))
 </MACRO>
 <MACRO>
-<NAME>GST_IS_XIMAGESRC_CLASS</NAME>
-#define GST_IS_XIMAGESRC_CLASS(obj) (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_XIMAGESRC))
+<NAME>GST_IS_ID3V2_MUX_CLASS</NAME>
+#define GST_IS_ID3V2_MUX_CLASS(klass) \
+  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_ID3V2_MUX))
 </MACRO>
-<STRUCT>
-<NAME>GstXImageSrc</NAME>
-</STRUCT>
-<STRUCT>
-<NAME>GstXImageSrcClass</NAME>
-</STRUCT>
 <FUNCTION>
-<NAME>gst_ximagesrc_get_type</NAME>
+<NAME>gst_id3v2_mux_get_type</NAME>
 <RETURNS>GType </RETURNS>
 void
 </FUNCTION>
 <STRUCT>
-<NAME>GstXImageSrc</NAME>
-struct _GstXImageSrc
-{
-  GstPushSrc parent;
-
-  /* Information on display */
-  GstXContext *xcontext;
-  gint width;
-  gint height;
-  
-  Window xwindow;
-  gchar *display_name;
-  guint screen_num;
-  
-  /* Desired output framerate */
-  gint fps_n;
-  gint fps_d;
-  
-  /* for framerate sync */
-  GstClockID clock_id; 
-  gint64 last_frame_no;
-  
-  /* Protect X Windows calls */
-  GMutex *x_lock;
-
-  /* Gathered pool of emitted buffers */
-  GMutex *pool_lock;
-  GSList *buffer_pool;
-
-  /* XFixes and XDamage support */
-  gboolean have_xfixes;
-  gboolean have_xdamage;
-  gboolean show_pointer;
-#ifdef HAVE_XFIXES
-  int fixes_event_base;
-  XFixesCursorImage *cursor_image;
-
-#endif
-#ifdef HAVE_XDAMAGE
-  Damage damage;
-  int damage_event_base;
-  XserverRegion damage_region;
-  GC damage_copy_gc;
-#endif
-
-};
-</STRUCT>
-<STRUCT>
-<NAME>GstXImageSrcClass</NAME>
-struct _GstXImageSrcClass
-{
-  GstPushSrcClass parent_class;
-};
+<NAME>GstTagLibMux</NAME>
 </STRUCT>
 <STRUCT>
-<NAME>GstTagLibMuxPriv</NAME>
+<NAME>GstTagLibMuxClass</NAME>
 </STRUCT>
 <STRUCT>
-<NAME>GstTagLibMux</NAME>
+<NAME></NAME>
 typedef struct _GstTagLibMux {
   GstElement    element;
 
@@ -234,13 +199,16 @@ typedef struct _GstTagLibMux {
   gboolean      render_tag;
 
   GstEvent     *newsegment_ev; /* cached newsegment event from upstream */
-} GstTagLibMux;
+};
 </STRUCT>
 <STRUCT>
-<NAME>GstTagLibMuxClass</NAME>
+<NAME></NAME>
 typedef struct _GstTagLibMuxClass {
   GstElementClass parent_class;
-} GstTagLibMuxClass;
+
+  /* vfuncs */
+  GstBuffer  * (*render_tag) (GstTagLibMux * mux, GstTagList * tag_list);
+};
 </STRUCT>
 <MACRO>
 <NAME>GST_TYPE_TAG_LIB_MUX</NAME>
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index d20628c8..06115c72 100644
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -14,7 +14,7 @@
     <title>gst-plugins-bad Elements</title>
 
     <xi:include href="xml/element-dfbvideosink.xml" />
-    <xi:include href="xml/element-tagid3v2mux.xml" />
+    <xi:include href="xml/element-id3v2mux.xml" />
   </chapter>
 
   <chapter>
diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index c0b65657..23cd0f51 100644
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -7,10 +7,10 @@ GstDfbVideoSinkClass
 </SECTION>
 
 <SECTION>
-<FILE>element-tagid3v2mux</FILE>
-GstTagLibMux
-<TITLE>tagid3v2mux</TITLE>
+<FILE>element-id3v2mux</FILE>
+GstId3v2Mux
+<TITLE>id3v2mux</TITLE>
 <SUBSECTION Standard>
-GstTagLibMuxClass
+GstId3v2MuxClass
 </SECTION>
 
diff --git a/docs/plugins/gst-plugins-bad-plugins-undocumented.txt b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt
index fe024ba0..d9477cfc 100644
--- a/docs/plugins/gst-plugins-bad-plugins-undocumented.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-undocumented.txt
@@ -1,10 +1,9 @@
-83% symbol docs coverage.
-10 symbols documented.
+92% symbol docs coverage.
+11 symbols documented.
 0 symbols incomplete.
-2 not documented.
+1 not documented.
 
 
-GstTagLibMux
+GstId3v2Mux
 
 
-element-tagid3v2mux:Short_Description
-- 
cgit v1.2.1