[Boost-commit] svn:boost r68068 - sandbox/guild/pool/libs/pool/doc

Subject: [Boost-commit] svn:boost r68068 - sandbox/guild/pool/libs/pool/doc
From: pbristow_at_[hidden]
Date: 2011-01-12 13:42:27

Author: pbristow
Date: 2011-01-12 13:42:26 EST (Wed, 12 Jan 2011)
New Revision: 68068
URL: http://svn.boost.org/trac/boost/changeset/68068

Log:
Work in progress to show effect of adding a few Doxygen comments to pool class. 
Text files modified: 
   sandbox/guild/pool/libs/pool/doc/jamfile.v2 |   116 +++++++++++++++++++++++---------------- 
   1 files changed, 67 insertions(+), 49 deletions(-)

Modified: sandbox/guild/pool/libs/pool/doc/jamfile.v2
==============================================================================
--- sandbox/guild/pool/libs/pool/doc/jamfile.v2	(original)
+++ sandbox/guild/pool/libs/pool/doc/jamfile.v2	2011-01-12 13:42:26 EST (Wed, 12 Jan 2011)
@@ -13,20 +13,34 @@
 echo "images_location" $(images_location) ;
 echo "nav-images" $(nav-images) ;
 
-#import doxygen ;
+using doxygen ;  # Required if you want to use Doxygen.
 using quickbook ;
+#using auto-index ; # Required if you want to use autoindexing.
 
-#doxygen autodoc
-#   :
-#      [ glob ../../../boost/pool/*.hpp ]
-#   :
-#        <doxygen:param>EXTRACT_ALL=NO
-#        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
-#        <doxygen:param>EXTRACT_PRIVATE=NO
-#        <doxygen:param>EXPAND_ONLY_PREDEF=YES
-#        <doxygen:param>PREDEFINED=BOOST_INTERPROCESS_DOXYGEN_INVOKED
-#        <xsl:param>"boost.doxygen.reftitle=Boost.Pool Reference"
-#   ;
+doxygen autodoc
+   :
+      [ glob ../../../boost/pool/*.hpp ]
+      [ glob ../../../boost/pool/detail/*.hpp ]
+      #[ glob ../../../boost/pool/detail/*.inc ] #  These might better be named .ipp?
+      # The .inc are not recognised correctly by doxywizard leaving error message.
+      # Warning: include file boost/pool/detail/pool_construct.inc not found, perhaps you forgot to add its directory to INCLUDE_PATH?
+      #  and problem with 'no type' in jamfile.
+      # error: target { ../../../boost/pool/detail/pool_construct.inc. } has no type
+     
+      #[ glob ../../../boost/pool/examples/*.*pp ] # Example source files.
+   :
+			<doxygen:param>WARNINGS=YES # Default NO, but useful to see warnings, especially in a logfile.
+			# It is also wise to to set a warnings logfile like this:
+			<doxygen:param>WARN_LOGFILE=AutoDoxywarnings.log # This may not be empty (usually not a good sign!), depending on options chosen.
+			# Much better to send message to a logfile than the default stderr.
+			# and make sure that there are no Doxygen errors or significant warnings in the log file.
+			<doxygen:param>RECURSIVE=NO # Search recursively down subdirectories.
+      <doxygen:param>EXTRACT_ALL=NO
+			<doxygen:param>HIDE_UNDOC_MEMBERS=YES
+			<doxygen:param>EXTRACT_PRIVATE=NO
+			<doxygen:param>EXPAND_ONLY_PREDEF=YES
+			<xsl:param>"boost.doxygen.reftitle=Boost.Pool Reference"
+   ;
 
 xml pool : pool.qbk ;
 
@@ -55,42 +69,46 @@
                 <xsl:param>boost.image.w=180 # Width of logo in pixels. (JM has W = 162, h = 46)
     <xsl:param>boost.image.h=90 # Height of logo in pixels.
   
-        # HTML options:
-        # =============
-        # Use graphics not text for navigation:
-        <xsl:param>navig.graphics=1
-        # How far down we chunk nested sections, basically all of them:
-        <xsl:param>chunk.section.depth=2
-        # Don't put the first section on the same page as the TOC itself:
-        <xsl:param>chunk.first.sections=1
-        # How far down sections get TOC's
-        <xsl:param>toc.section.depth=4
-        # Max depth in each TOC:
-        <xsl:param>toc.max.depth=2
-        # How far down we go with TOC's
-        <xsl:param>generate.section.toc.level=10
-        # Path for links to Boost:
-
-        # PDF Options:
-        # TOC Generation: this is needed for FOP-0.9 and later:
-        <format>pdf:<xsl:param>fop1.extensions=0
-        # Or enable this if you're using XEP:
-        <format>pdf:<xsl:param>xep.extensions=1
-        # TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
-        <format>pdf:<xsl:param>fop.extensions=0
-        # No indent on body text:
-        <xsl:param>body.start.indent=0pt
-        # Margin size:
-        <xsl:param>page.margin.inner=0.5in
-        # Margin size:
-        <xsl:param>page.margin.outer=0.5in
-        # Yes, we want graphics for admonishments:
-        <xsl:param>admon.graphics=1
-        # Set this one for PDF generation *only*:
-        # default png graphics are awful in PDF form,
-        # better use SVG instead:
-        <format>pdf:<xsl:param>admon.graphics.extension=".svg"
-        <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
+		# HTML options:
+		# =============
+		# Use graphics icons not text for navigation:
+		<xsl:param>navig.graphics=1
+		# How far down we chunk nested sections, basically all of them:
+		<xsl:param>chunk.section.depth=2
+		# Don't put the first section on the same page as the TOC itself:
+		<xsl:param>chunk.first.sections=1
+		# How far down sections get TOC's
+		<xsl:param>toc.section.depth=4
+		# Max depth in each TOC:
+		<xsl:param>toc.max.depth=2
+		# How far down we go with TOC's
+		<xsl:param>generate.section.toc.level=10
+		# Path for links to Boost:
+
+		# PDF Options:
+		# ============
+		# TOC Generation: this is needed for FOP-0.9 and later:
+		<format>pdf:<xsl:param>fop1.extensions=0
+		# Or enable this if you're using XEP:
+		<format>pdf:<xsl:param>xep.extensions=1
+		# TOC generation: this is needed for FOP 0.2, but must not be set to zero for FOP-0.9!
+		<format>pdf:<xsl:param>fop.extensions=0
+		# No indent on body text:
+		<xsl:param>body.start.indent=0pt
+		# Margin size:
+		<xsl:param>page.margin.inner=0.5in
+		# Margin size:
+		<xsl:param>page.margin.outer=0.5in
+		# Yes, we want graphics for admonishments:
+		<xsl:param>admon.graphics=1
+		# Set this one for PDF generation *only*:
+		# default png graphics are awful in PDF form,
+		# better use SVG instead:
+		<format>pdf:<xsl:param>admon.graphics.extension=".svg"
+		<format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
+		
+		<dependency>autodoc #
+
    ;
 
-install pdf-install : standalone : <location>. <install-type>PDF ;
+install pdf-install : standalone : <location>. <install-type>PDF ; # copy pdf to same location as .qbk