fix docs build

Original commit message from CVS:
fix docs build

ChangeLog

@@ -1,3 +1,9 @@
+2004-07-28  Thomas Vander Stichele  <thomas at apestaart dot org>
+
+	* docs/gst/Makefile.am:
+	* docs/libs/Makefile.am:
+	  clean up docs build.  Fixes needless rebuilding of template files.
+
 2004-07-28  Wim Taymans  <wim@fluendo.com>
 
 	* gst/gstbin.c: (set_kid_state_func), (gst_bin_set_state):
@@ -53,7 +59,8 @@
 2004-07-26  Steve Lhomme  <steve.lhomme@free.fr>
 
 	* win32/gstreamer.def:
-	  add many definitions needed by plugins, GST_CAT_DEFAULT only available in the Debug build ?
+	  add many definitions needed by plugins,
+	  GST_CAT_DEFAULT only available in the Debug build ?
 
 2004-07-26  Thomas Vander Stichele  <thomas at apestaart dot org>
 

docs/gst/Makefile.am

@@ -156,7 +156,7 @@ SCANOBJ_FILES =				\
 	$(DOC_MODULE).hierarchy		\
 	$(DOC_MODULE).interfaces	\
 	$(DOC_MODULE).prerequisites	\
-	$(DOC_MODULE)-scan.o		\
+	.libs/$(DOC_MODULE)-scan.o	\
 	$(DOC_MODULE).signals
 
 CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
@@ -170,12 +170,16 @@ all-local: html-build.stamp
 # to gtk-doc scanning; but only then, to avoid duplicates
 scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
 	@echo '*** Scanning header files ***'
-	if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
+	if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null;	\
+	then								\
 	    if test x"$(srcdir)" != x. ; then				\
 	        cp $(srcdir)/$(DOC_MODULE).types . ;			\
 	        chmod u+w $(DOC_MODULE).types ;				\
 	    fi ;							\
-	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)" --module=$(DOC_MODULE) ; \
+	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" 			\
+	    CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"		\
+	    $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"	\
+	        --module=$(DOC_MODULE) ;				\
 	else								\
 	    cd $(srcdir) ;						\
 	    for i in $(SCANOBJ_FILES) ; do				\
@@ -241,7 +245,7 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files)
 	cp ../version.entities html
 	cd html && gtkdoc-mkhtml $(DOC_MODULE) $(DOC_MAIN_SGML_FILE)
 	rm -f html/$(DOC_MAIN_SGML_FILE)
-	rm -rf xml
+	rm -rf html/xml
 	rm -f html/version.entities
 	test "x$(HTML_IMAGES)" = "x" || for i in "" $(HTML_IMAGES) ; do \
 	    if test "$$i" != ""; then cp $(srcdir)/$$i html ; fi; done

docs/libs/Makefile.am

@@ -47,7 +47,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 --output-format=xml --ignore-files=trio
+MKDB_OPTIONS=--sgml-mode --ignore-files=trio
 
 # Extra options to supply to gtkdoc-fixref.
 FIXXREF_OPTIONS=--extra-dir=../gst/html
@@ -113,36 +113,60 @@ EXTRA_DIST = 				\
 	$(DOC_MODULE).types		\
 	$(DOC_MODULE)-sections.txt
 
-DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp \
+DOC_STAMPS = 				\
-	   $(srcdir)/tmpl.stamp $(srcdir)/sgml.stamp $(srcdir)/html.stamp
+	scan-build.stamp		\
+	tmpl-build.stamp		\
+	sgml-build.stamp		\
+	html-build.stamp		\
+	$(srcdir)/tmpl.stamp		\
+	$(srcdir)/sgml.stamp		\
+	$(srcdir)/html.stamp
 
 SCANOBJ_FILES =				\
 	$(DOC_MODULE).args 		\
 	$(DOC_MODULE).hierarchy 	\
+	$(DOC_MODULE).interfaces 	\
+	$(DOC_MODULE).prerequisites 	\
+	.libs/$(DOC_MODULE)-scan.o	\
 	$(DOC_MODULE).signals
 
+CLEANFILES = $(SCANOBJ_FILES) $(DOC_MODULE)-unused.txt $(DOC_STAMPS)
+
 if HAVE_GTK_DOC
 all-local: html-build.stamp
 
 #### scan ####
 
-
+# in the case of non-srcdir builds, the built gst directory gets added
-# wingo addition
+# to gtk-doc scanning; but only then, to avoid duplicates
 scan-build.stamp: $(HFILE_GLOB) $(SCANOBJ_DEPS) $(basefiles)
 	@echo '*** Scanning header files ***'
-	if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null ; then \
+	if grep -l '^..*$$' $(srcdir)/$(DOC_MODULE).types > /dev/null;	\
-	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --module=$(DOC_MODULE) --output-dir=$(srcdir) ; \
+	then								\
             if test x"$(srcdir)" != x. ; then				\
                 cp $(srcdir)/$(DOC_MODULE).types . ;			\
+                chmod u+w $(DOC_MODULE).types ;				\
             fi ;							\
-	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" $(GTK_DOC_SCANOBJ) --module=$(DOC_MODULE) ; \
+	    CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)"				\
+	    CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)"		\
+	    $(GTK_DOC_SCANOBJ) --type-init-func="gst_init(NULL,NULL)"	\
+	        --module=$(DOC_MODULE) ;				\
 	else								\
 	    cd $(srcdir) ;						\
 	    for i in $(SCANOBJ_FILES) ; do				\
 	       test -f $$i || touch $$i ;				\
 	    done							\
 	fi
-	gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES)
+	if test "x$(top_srcdir)" != "x$(top_builddir)";			\
+	then								\
+	  export BUILT_OPTIONS="--source-dir=$(top_builddir)/gst-libs";	\
+	fi;								\
+	gtkdoc-scan							\
+		$(SCAN_OPTIONS) $(EXTRA_HFILES)				\
+		--module=$(DOC_MODULE)					\
+		--source-dir=$(DOC_SOURCE_DIR)				\
+		$$BUILT_OPTIONS						\
+		--ignore-headers="$(IGNORE_HFILES)"
 	touch scan-build.stamp
 
 $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp

docs/libs/tmpl/gstgetbits.sgml

@@ -129,6 +129,8 @@ Accelerated routines for getting bits from a data stream
 </para>
 
 @gb: 
+@n: 
+<!-- # Unused Parameters # -->
 @num: 
 
 
@@ -322,6 +324,8 @@ Accelerated routines for getting bits from a data stream
 </para>
 
 @gb: 
+@n: 
+<!-- # Unused Parameters # -->
 @num: 
 
 
@@ -531,6 +535,8 @@ Accelerated routines for getting bits from a data stream
 </para>
 
 @gb: 
+@n: 
+<!-- # Unused Parameters # -->
 @num: 
 
 
@@ -548,6 +554,8 @@ Accelerated routines for getting bits from a data stream
 </para>
 
 @gb: 
+@n: 
+<!-- # Unused Parameters # -->
 @num: