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

Subject: [Boost-commit] svn:boost r68234 - sandbox/guild/pool/libs/pool/doc
From: pbristow_at_[hidden]
Date: 2011-01-18 13:09:59

Author: pbristow
Date: 2011-01-18 13:09:57 EST (Tue, 18 Jan 2011)
New Revision: 68234
URL: http://svn.boost.org/trac/boost/changeset/68234

Log:
All doxygen comments done in code, and index added.
Text files modified: 
   sandbox/guild/pool/libs/pool/doc/pool.qbk |    39 ++++++++++++++++++++++++++++++++++++++- 
   1 files changed, 38 insertions(+), 1 deletions(-)

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-18 13:09:57 EST (Tue, 18 Jan 2011)
@@ -993,6 +993,14 @@
 
 [xinclude autodoc.xml] [/ 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?"
+This is unavoidable because these must be included in the middle of the class declaration.
+All the automatically generated constructors are documented in the Doxygen standalone version:
+only the access to source files is missing.
+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.]
+
 [endsect] [/section:pool Boost Pool Library]
 
 [section:appendices Appendices]
@@ -1125,7 +1133,36 @@
 This "pool_base" interface will be Singleton Usage with Exceptions,
 and built on the singleton_pool interface.
 
-[endsect] [/section:todo  Appendix J: Future plans]
+Many functions need better Doxygen comments about their function.  (rebind in particular is undocumented).
 
+These comments appear in the reference section.
+
+[endsect] [/section:todo  Appendix J: Future plans]
 
 [endsect] [/section:appendices Appendices]
+
+[section:indexes Indexes]
+
+[? enable_index
+'''
+  <index type="function_name">
+  <title>Function Index</title>
+  </index>
+  <index type="class_name">
+  <title>Class Index</title>
+  </index>
+  <index type="typedef_name">
+  <title>Typedef Index</title>
+  </index>
+'''
+]
+
+[/ BOOST_PREVENT_MACRO_SUBSTITUTION is the only macro and not sure if useful?
+  but after removing still get BOOST_PREVENT_MACRO_SUBSTITUTION in the function index.
+	<index type="macro_name">
+	<title>Macro Index</title>
+	</index>
+	<index/>
+]
+
+[endsect] [/section:indexes Indexes]