From: Thomas Vander Stichele <thomas@apestaart.org>
Date: Wed, 28 Jul 2004 11:56:19 +0000 (+0000)
Subject: fix gst-libs docs build
X-Git-Tag: RELEASE-0_8_6~104
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=06bb8beb03e629fb90c50131c2a2dcb0edb8047c;p=platform%2Fupstream%2Fgstreamer.git

fix gst-libs docs build

Original commit message from CVS:
fix gst-libs docs build
---

diff --git a/ChangeLog b/ChangeLog
index 98dc21f..8a0505a 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2004-07-28  Thomas Vander Stichele  <thomas at apestaart dot org>
 
+	* docs/gst/gstreamer-docs.sgml:
+	* docs/libs/Makefile.am:
+	* docs/libs/gstreamer-libs-docs.sgml:
+	* docs/libs/gstreamer-libs-sections.txt:
+	* libs/gst/control/dparam.c:
+	  more doc fixes.  gst-libs docs now build the same way as gst.
+
+2004-07-28  Thomas Vander Stichele  <thomas at apestaart dot org>
+
 	* configure.ac:
 	* testsuite/Makefile.am:
 	* testsuite/bins/Makefile.am:
diff --git a/docs/gst/gstreamer-docs.sgml b/docs/gst/gstreamer-docs.sgml
index d6bbc4a..597d7bd 100644
--- a/docs/gst/gstreamer-docs.sgml
+++ b/docs/gst/gstreamer-docs.sgml
@@ -74,6 +74,8 @@
 <!ENTITY GstMD5Sink SYSTEM "xml/gstmd5sink.xml">
 <!ENTITY GstTee SYSTEM "xml/gsttee.xml">
 -->
+
+<!-- generated by gtkdoc-mkdb, stupid name -->
 <!ENTITY gstreamer-tree-index SYSTEM "xml/tree_index.sgml">
 
 <!ENTITY hash "#">
diff --git a/docs/libs/Makefile.am b/docs/libs/Makefile.am
index 2841b89..84ee3b0 100644
--- a/docs/libs/Makefile.am
+++ b/docs/libs/Makefile.am
@@ -189,8 +189,10 @@ tmpl.stamp: tmpl-build.stamp
 #### sgml ####
 
 sgml-build.stamp: tmpl.stamp $(CFILE_GLOB)
-	@echo '*** Building SGML ***'
-	gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) $(MKDB_OPTIONS)
+	@echo '*** Building XML ***'
+	gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --main-sgml-file=$(srcdir)/$(DOC_MAIN_SGML_FILE) --output-format=xml $(MKDB_OPTIONS) | tee sgml-build.log
+	@if grep "WARNING:" sgml-build.log > /dev/null; then exit 1; fi
+	rm sgml-build.log
 	touch sgml-build.stamp
 
 sgml.stamp: sgml-build.stamp
diff --git a/docs/libs/gstreamer-libs-docs.sgml b/docs/libs/gstreamer-libs-docs.sgml
index 02f6106..3571b6d 100644
--- a/docs/libs/gstreamer-libs-docs.sgml
+++ b/docs/libs/gstreamer-libs-docs.sgml
@@ -10,7 +10,8 @@
 <!ENTITY GstControl SYSTEM "xml/gstcontrol.xml">
 <!ENTITY GstDataProtocol SYSTEM "xml/gstdataprotocol.xml">
 
-<!ENTITY gstlibs-tree-index SYSTEM "xml/tree_index.sgml">
+<!-- generated by gtkdoc-mkdb, stupid name -->
+<!ENTITY gstreamer-libs-tree-index SYSTEM "xml/tree_index.sgml">
 
 <!ENTITY hash "#">
 ]>
@@ -40,7 +41,7 @@
 
   <chapter id="gstreamer-libs-hierarchy">
     <title>Object Hierarchy</title>
-    &gstlibs-tree-index;
+    &gstreamer-libs-tree-index;
   </chapter>
 
   <index id="api-index">
diff --git a/docs/libs/gstreamer-libs-sections.txt b/docs/libs/gstreamer-libs-sections.txt
index 00b6530..d66291c 100644
--- a/docs/libs/gstreamer-libs-sections.txt
+++ b/docs/libs/gstreamer-libs-sections.txt
@@ -75,7 +75,6 @@ gst_showbitsX
 gst_flushbitsX
 gst_backbitsX
 swab32
-DEBUG
 </SECTION>
 
 <SECTION>
diff --git a/libs/gst/control/dparam.c b/libs/gst/control/dparam.c
index f4fec2c..32654c3 100644
--- a/libs/gst/control/dparam.c
+++ b/libs/gst/control/dparam.c
@@ -310,8 +310,11 @@ gst_dparam_dispose (GObject * object)
  * gst_dparam_attach
  * @dparam: GstDParam instance
  * @manager: the GstDParamManager that this dparam belongs to
+ * @param_spec: the specification for the parameter
+ * @unit_name: the name of the unit
  *
- * Adding the parameter controller to the manager using the supplied specs and unit.
+ * Adding the parameter controller to the manager using the
+ * supplied specs and unit.
  * See also gst_dpman_attach_dparam().
  */
 void
@@ -341,7 +344,6 @@ gst_dparam_attach (GstDParam * dparam, GstDParamManager * manager,
 /**
  * gst_dparam_detach
  * @dparam: GstDParam instance
- * @manager: the GstDParamManager that this dparam belongs to
  *
  * Removes a previousely added parameter controller.
  */