[Boost-commit] svn:boost r50201 - trunk/doc/test

Subject: [Boost-commit] svn:boost r50201 - trunk/doc/test
From: john_at_[hidden]
Date: 2008-12-08 12:59:13

Author: johnmaddock
Date: 2008-12-08 12:59:12 EST (Mon, 08 Dec 2008)
New Revision: 50201
URL: http://svn.boost.org/trac/boost/changeset/50201

Log:
Added Doxygen test case.
Text files modified: 
   trunk/doc/test/Jamfile.v2 |   137 ++++++++++++++++++++++++++++++++++++++++
   trunk/doc/test/test.qbk   |     7 +                                       
   2 files changed, 141 insertions(+), 3 deletions(-)

Modified: trunk/doc/test/Jamfile.v2
==============================================================================
--- trunk/doc/test/Jamfile.v2	(original)
+++ trunk/doc/test/Jamfile.v2	2008-12-08 12:59:12 EST (Mon, 08 Dec 2008)
@@ -2,13 +2,150 @@
 # subject to the Boost Software License, Version 1.0. (See accompanying
 # file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
 
+import os ;
+import common ;
+import doxygen ;
 using quickbook ;
 
+#
+# Accumulators docs are dependent upon
+# latex dvips and ps being in your PATH.
+# This is true for most Unix installs, but
+# not on Win32, where you will need to install
+# MkTex and Ghostscript and add these tools
+# to your path.
+#
+make latex.check : : @check-latex ;
+actions check-latex
+{
+    latex -version > latex.version
+}
+
+make dvips.check : : @check-dvips ;
+actions check-dvips
+{
+    dvips -version > dvips.version
+}
+
+make gs.check : : @check-gs ;
+
+import os ;
+
+if [ os.name ] = "NT"
+{
+   actions check-gs
+   {
+       gswin32c -version > gs.version
+   }
+}
+else
+{
+   actions check-gs
+   {
+       gs -version > gs.version
+   }
+}
+
+
+# Use Doxygen to emit a tagfile with the definition of depends_on<>. That
+# tagfile will be used by Doxygen below when generating the Statistics Library
+# Reference. This is all so that the Doxygen-generated documentation for the
+# features shows the dependency relationships between them.
+doxygen tagfile
+    :
+        ../../boost/accumulators/framework/depends_on.hpp
+        ../../boost/accumulators/framework/extractor.hpp
+    :
+        <doxygen:param>MACRO_EXPANSION=YES
+        <doxygen:param>EXPAND_ONLY_PREDEF=YES
+        <doxygen:param>GENERATE_TAGFILE=accumulators.tag
+        <doxygen:param>"PREDEFINED=\"BOOST_ACCUMULATORS_DOXYGEN_INVOKED=1\" \\
+                                   \"BOOST_PP_REPEAT_FROM_TO(a,b,c,d)=\" \\
+                                   \"BOOST_PP_ENUM_PARAMS(a,b)=b ## 1, b ## 2, ...\""
+        <dependency>latex.check
+        <dependency>dvips.check
+        <dependency>gs.check
+    ;
+
+# Generate the HTML form of the stats documentation, as this causes Doxygen to
+# generate .png images for the LaTeX formulas embedded in the doc comments.
+doxygen statsdoc.html
+    :
+        ../../boost/accumulators/statistics/weighted_tail_quantile.hpp
+    :
+        <dependency>latex.check
+        <dependency>dvips.check
+        <dependency>gs.check
+    ;
+
+if [ os.name ] = NT
+{
+    CP = copy /y ;
+    MKDIR = mkdir ;
+    FROM = \\..\\..\\..\\html\\statsdoc\\*.png ;
+    TOHTML = .\\html\\images\\accumulators ;
+    TOPDF = \\images\\accumulators ;
+}
+else
+{
+    CP = cp ;
+    MKDIR = mkdir -p ;
+    FROM = /../../html/statsdoc/*.png ;
+    TOHTML = ./html/images/accumulators ;
+    TOPDF = /images/accumulators ;
+}
+
+actions copy-latex-pngs
+{
+    $(MKDIR) $(TOHTML)
+    $(MKDIR) $(<:D)$(TOPDF)
+    $(CP) $(<:D)$(FROM) $(TOHTML)
+    $(CP) $(<:D)$(FROM) $(<:D)$(TOPDF)
+    echo "Stamped" > "$(<)"
+}
+
+# This causes the png files built above to be copied into the
+# html/images/accumulators directory.
+make statsdoclatex.tag
+    : statsdoc.html
+    : @copy-latex-pngs
+    ;
+
+doxygen statsdoc
+    :
+        ../../boost/accumulators/statistics/weighted_tail_quantile.hpp
+    :
+        <doxygen:param>EXTRACT_ALL=YES
+        <doxygen:param>"PREDEFINED=\"BOOST_ACCUMULATORS_DOXYGEN_INVOKED=1\" \\
+                                   \"BOOST_PP_REPEAT_FROM_TO(a,b,c,d)=\" \\
+                                   \"BOOST_PP_REPEAT(a,b,c)=\" \\
+                                   \"BOOST_PARAMETER_KEYWORD(a,b)=\\
+                                         namespace a { struct b {}; } \\
+                                         boost::parameter::keyword<a::b> const b;\" \\
+                                   \"BOOST_PP_ENUM_PARAMS(a,b)=b ## 1, b ## 2, ...\""
+        <doxygen:param>HIDE_UNDOC_MEMBERS=NO
+        <doxygen:param>EXTRACT_PRIVATE=NO
+        <doxygen:param>ENABLE_PREPROCESSING=YES
+        <doxygen:param>MACRO_EXPANSION=YES
+        <doxygen:param>EXPAND_ONLY_PREDEF=YES
+        <doxygen:param>SEARCH_INCLUDES=NO
+        <doxygen:param>TAGFILES=accumulators.tag
+        <xsl:param>boost.doxygen.formuladir=images/accumulators/
+        <reftitle>"Statistics Library Reference"
+        <dependency>tagfile
+        <dependency>statsdoclatex.tag
+        <dependency>latex.check
+        <dependency>dvips.check
+        <dependency>gs.check
+    ;
+
 xml test : test.qbk ;
 boostbook standalone
     :
         test
     :
+        <dependency>statsdoc
+
         # HTML options first:
         #======================================================================
 

Modified: trunk/doc/test/test.qbk
==============================================================================
--- trunk/doc/test/test.qbk	(original)
+++ trunk/doc/test/test.qbk	2008-12-08 12:59:12 EST (Mon, 08 Dec 2008)
@@ -591,7 +591,7 @@
 
 [include remez.qbk]
 
-[section:array Array Example Library Documentation]
+[section:array Array Example Boostbook XML Documentation]
 [xinclude array.xml]
 [xinclude array1.xml]
 [xinclude array2.xml]
@@ -599,7 +599,8 @@
 [xinclude array4.xml]
 [endsect]
 
-
-
+[section:accumulators Accumulators Example Doxygen Documentation]
+[xinclude statsdoc.xml]
+[endsect]