[Xcb-commit] 3 commits - acinclude.m4 doc src xcb.doxygen

[Jamey Sharp]

 acinclude.m4     |    4 ----
 doc/Makefile.am  |   39 +++++++++++++++------------------------
 src/c-client.xsl |   21 +++++++++------------
 xcb.doxygen      |    5 +++--
 4 files changed, 27 insertions(+), 42 deletions(-)

New commits:
diff-tree aedfa1fe1d91a10ccfe3ee6ac6b7a25885623dc6 (from 44a2160c95f6c90d461d66c0278348c62d2d77fa)
Author: Jamey Sharp <jamey at minilop.net>
Date:   Sat Nov 18 21:30:12 2006 -0800

    Fix Doxygen warnings.
    
    Specifically, fixes these two warnings which were emitted for every
    generated source file:
    
    * Warning: end of file while inside a group
    * Warning: group XCB_BigRequests_API already documented. Skipping documentation.

diff --git a/src/c-client.xsl b/src/c-client.xsl
index 31b6de5..d5d2b35 100644
--- a/src/c-client.xsl
+++ b/src/c-client.xsl
@@ -973,11 +973,13 @@ authorization from the authors.
       -->__<xsl:value-of select="$ucase-header" />_H<!--
     --></xsl:variable>
 
-<xsl:text>/**
- * @file </xsl:text><xsl:value-of select="$header" /><xsl:text>.h
- **/
+<xsl:text>/*
+ * This file generated automatically from </xsl:text>
+<xsl:value-of select="$header" /><xsl:text>.xml by c-client.xsl using XSLT.
+ * Edit at your peril.
+ */
 </xsl:text>
-<xsl:text>
+<xsl:if test="$h"><xsl:text>
 /**
  * @defgroup XCB_</xsl:text><xsl:value-of select="$ext" /><xsl:text>_API XCB </xsl:text><xsl:value-of select="$ext" /><xsl:text> API
  * @brief </xsl:text><xsl:value-of select="$ext" /><xsl:text> XCB Protocol Implementation.</xsl:text>
@@ -985,14 +987,8 @@ authorization from the authors.
  * @{
  **/
 </xsl:text>
-<xsl:text>/*
- * This file generated automatically from </xsl:text>
-<xsl:value-of select="$header" /><xsl:text>.xml by c-client.xsl using XSLT.
- * Edit at your peril.
- */
-</xsl:text>
 
-<xsl:if test="$h"><xsl:text>
+<xsl:text>
 #ifndef </xsl:text><xsl:value-of select="$guard" /><xsl:text>
 #define </xsl:text><xsl:value-of select="$guard" /><xsl:text>
 </xsl:text>
@@ -1028,10 +1024,11 @@ authorization from the authors.
 
 <xsl:if test="$h">
 <xsl:text>
+#endif
+
 /**
  * @}
  */
-#endif
 </xsl:text>
 </xsl:if>
   </xsl:template>
diff-tree 44a2160c95f6c90d461d66c0278348c62d2d77fa (from 142fe9a6f2b13d42b0e4baaa25155067f45d065b)
Author: Jamey Sharp <jamey at minilop.net>
Date:   Sat Nov 18 19:36:48 2006 -0800

    Make doc installation work and simplify doc/Makefile.am.
    
    Don't override the default htmldir with an unquoted copy.
    
    Don't suppress `make` echoing on Doxygen commands.
    
    Ensure the tutorial is always installed even if Doxygen isn't
    available.
    
    Take better advantage of the automake installation infrastructure.

diff --git a/acinclude.m4 b/acinclude.m4
index 27fda42..186873c 100644
--- a/acinclude.m4
+++ b/acinclude.m4
@@ -99,10 +99,6 @@ AC_DEFUN([AM_CHECK_DOXYGEN],
     dnl Substitution
     dnl
     AC_SUBST([DOXYGEN])
-    dnl according to the autoconf doc, htmldir == docdir == ${prefix}/share/doc/${PACKAGE_NAME}
-    dnl I tried to use docdir, without success
-    htmldir=${prefix}/share/doc/${PACKAGE_NAME}
-    AC_SUBST(htmldir)
     AM_CONDITIONAL(BUILD_DOCS, test "x$BUILD_DOCS" = "xyes")
    ])
 dnl End of acinclude.m4
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 4b0ec90..f46f0b1 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -3,38 +3,29 @@ EXTRA_DIST = \
 tutorial/index.html \
 tutorial/xcb.css
 
-if BUILD_DOCS
+htmlDATA_INSTALL = cp -pR
 
-# install documentation
+html_DATA = tutorial/
 
-all-local: doc-build.stamp
+uninstall-htmlDATA:
+	@$(NORMAL_UNINSTALL)
+	@list='$(html_DATA)'; for p in $$list; do \
+	  f=$(am__strip_dir) \
+	  echo " rm -rf '$(DESTDIR)$(htmldir)/$$f'"; \
+	  rm -rf "$(DESTDIR)$(htmldir)/$$f"; \
+	done
+	rmdir "$(DESTDIR)$(htmldir)/" || true
 
-# rule to remove all old created files
-doc-prepare.stamp:
-	@if test -d manual/ ; then \
-	  rm -rf manual/; \
-	fi
+if BUILD_DOCS
 
 # rule to build documentation and copy necessary files
-doc-build.stamp: doc-prepare.stamp
-	@cd .. && doxygen xcb.doxygen
+manual: clean-local
+	cd .. && doxygen xcb.doxygen
 
 # rules to clean
 clean-local:
-	@rm -rf manual/
-
-install-data-local: install-html-local
+	rm -rf manual/
 
-# rule to install the html documentation and tutorial in $(htmldir)
-install-html-local:
-	@if ! test -d "$(DESTDIR)$(htmldir)"; then \
-	  $(mkinstalldirs) "$(DESTDIR)$(htmldir)"; \
-	fi
-	@cp -pr manual/ "$(DESTDIR)$(htmldir)"
-	@cp -pr tutorial/ "$(DESTDIR)$(htmldir)"
-
-# rule to uninstall the documentation
-uninstall-local:
-	@rm -rf $(DESTDIR)$(htmldir)
+html_DATA += manual/
 
 endif
diff-tree 142fe9a6f2b13d42b0e4baaa25155067f45d065b (from 3634299ecc5223e8505d19468cf04770ac08ec14)
Author: Jamey Sharp <jamey at minilop.net>
Date:   Sat Nov 18 16:51:01 2006 -0800

    Turn off Doxygen warnings for undocumented API, for now.
    
    But warn about absent parameter documentation for functions that are
    otherwise documented.

diff --git a/xcb.doxygen b/xcb.doxygen
index ff80d14..1f4bb73 100644
--- a/xcb.doxygen
+++ b/xcb.doxygen
@@ -418,7 +418,8 @@ WARNINGS               = YES
 # for undocumented members. If EXTRACT_ALL is set to YES then this flag will
 # automatically be disabled.
 
-WARN_IF_UNDOCUMENTED   = YES
+# XXX: In the future this should be turned on. For now it generates too much noise.
+WARN_IF_UNDOCUMENTED   = NO
 
 # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
 # potential errors in the documentation, such as not documenting some
@@ -433,7 +434,7 @@ WARN_IF_DOC_ERROR      = YES
 # wrong or incomplete parameter documentation, but not about the absence of
 # documentation.
 
-WARN_NO_PARAMDOC       = NO
+WARN_NO_PARAMDOC       = YES
 
 # The WARN_FORMAT tag determines the format of the warning messages that
 # doxygen can produce. The string should contain the $file, $line, and $text