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

Subject: [Boost-commit] svn:boost r68454 - sandbox/guild/pool/libs/pool/doc
From: pbristow_at_[hidden]
Date: 2011-01-26 11:52:53

Author: pbristow
Date: 2011-01-26 11:52:50 EST (Wed, 26 Jan 2011)
New Revision: 68454
URL: http://svn.boost.org/trac/boost/changeset/68454

Log:
Some cosmetic changes (including failing to deal with details::PODptr problem.
Binary files modified: 
   sandbox/guild/pool/libs/pool/doc/pool.pdf
Text files modified: 
   sandbox/guild/pool/libs/pool/doc/jamfile.v2 |    17 +++++++++++------                       
   sandbox/guild/pool/libs/pool/doc/pool.qbk   |    22 ++++++++++++++++++----                  
   2 files changed, 29 insertions(+), 10 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-26 11:52:50 EST (Wed, 26 Jan 2011)
@@ -21,8 +21,9 @@
    ECHO "Building the Pool docs with automatic index generation enabled." ;
    using auto-index ;
    project : requirements
-        <auto-index>on # Turns on index (or off).
-        
+         # <auto-index>on turns on index (or off).
+        <auto-index>on
+                
         # Choose indexing method (separately for html and pdf):
         <format>html:<auto-index-internal>on  # on (or off) to use internally generated indexes.
         # <format>html:<xsl:param>generate.index=0 # Don't let the XSL stylesheets generate indexes.
@@ -34,10 +35,14 @@
         # PDF native index support is probably better for PDFs as then you actually get page numbers.
 
         <auto-index-script>index.idx # Specifies the name of the script to load. 
-        # <auto-index-prefix>../../../.. used by math
-        # <auto-index-prefix>../../../ # OK
+        # <auto-index-prefix>../../../ # Path to /pool so index.idx !scan-path can use boost/ and libs/doc.
         <auto-index-prefix>../../.. 
-        <quickbook-define>enable_index ;
+        
+        <quickbook-define>enable_index
+        
+        # <auto-index-verbose>on
+        
+        ;
 }
 else
 {
@@ -70,7 +75,7 @@
                         <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"
+			<xsl:param>"boost.doxygen.reftitle=Boost.Pool C++ Reference"
    ;
 
 xml pool : pool.qbk ;

Modified: sandbox/guild/pool/libs/pool/doc/pool.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/guild/pool/libs/pool/doc/pool.qbk
==============================================================================
--- sandbox/guild/pool/libs/pool/doc/pool.qbk	(original)
+++ sandbox/guild/pool/libs/pool/doc/pool.qbk	2011-01-26 11:52:50 EST (Wed, 26 Jan 2011)
@@ -257,7 +257,7 @@
 [endsect] [/section pool]
 
 
-[section:object_pool object_pool]
+[section:object_pool Object_pool]
 
 The [classref boost::object_pool template class object_pool] 
 interface is an Object Usage interface with Null Return,
@@ -327,7 +327,7 @@
 
 [endsect] [/section object_pool]
 
-[section:singleton_pool singleton_pool]
+[section:singleton_pool Singleton_pool]
 
 The [classref boost::singleton_pool singleton_pool interface]
 at [headerref boost/pool/singleton_pool.hpp singleton_pool.hpp] 
@@ -991,7 +991,7 @@
 
 [endsect] [/section:pooling Pool in more depth]
 
-[xinclude autodoc.xml] [/ Using Doxygen reference documentation.]
+[xinclude autodoc.xml] [/ Boost.Pool Reference section, using Doxygen reference documentation.]
 
 [/Note that there will be always some warnings about the .ipp files in Doxygen warnings and Autodoxywarnings.log files. 
 "Warning: include file boost/pool/detail/pool_construct.ipp not found, perhaps you forgot to add its directory to INCLUDE_PATH?"
@@ -1001,6 +1001,20 @@
 The current Quickbook version does not deal with the /details directory so the problem does not arise
 - unless the details files are included in future.]
 
+[/Note also that there is something funny about implementation class PODptr.
+It is always necessary to qualify it thus "details::PODptr"
+
+and this confuses Doxygen complaining thus:
+
+Cannot find class named 'details::PODptr'
+Cannot find class named 'details::PODptr'
+Cannot find class named 'details::PODptr'
+Cannot find class named 'details::PODptr'
+
+Attempts to avoid this with "using boost::details::PODptr;" have so far failed.
+
+]
+
 [endsect] [/section:pool Boost Pool Library]
 
 [section:appendices Appendices]
@@ -1161,7 +1175,7 @@
 '''
 ]
 
-[/ BOOST_PREVENT_MACRO_SUBSTITUTION is the only macro and not sure if useful?
+[/ BOOST_PREVENT_MACRO_SUBSTITUTION is the only macro and not sure if useful to show here?
   but after removing still get BOOST_PREVENT_MACRO_SUBSTITUTION in the function index.
         <index type="macro_name">
         <title>Macro Index</title>