Boost logo

Boost-Commit :

Date view Thread view Subject view Author view

Subject: [Boost-commit] svn:boost r70771 - in sandbox/opaque/libs/opaque/doc: . html
From: vicente.botet_at_[hidden]
Date: 2011-03-30 19:06:19

Author: viboes
Date: 2011-03-30 19:06:18 EDT (Wed, 30 Mar 2011)
New Revision: 70771
URL: http://svn.boost.org/trac/boost/changeset/70771

Log:
Opaque: update doc
Text files modified:
   sandbox/opaque/libs/opaque/doc/Jamfile.v2 | 115 ++++++++++-----------------------------
   sandbox/opaque/libs/opaque/doc/html/index.html | 2
   2 files changed, 30 insertions(+), 87 deletions(-)

Modified: sandbox/opaque/libs/opaque/doc/Jamfile.v2
==============================================================================
--- sandbox/opaque/libs/opaque/doc/Jamfile.v2 (original)
+++ sandbox/opaque/libs/opaque/doc/Jamfile.v2 2011-03-30 19:06:18 EDT (Wed, 30 Mar 2011)
@@ -40,34 +40,8 @@
         <quickbook-define>enable_index
         
         # <auto-index-verbose>on
-
- ;
-}
-else
-{
- ECHO "Building the Opaque docs with automatic index generation disabled. To get an auto-index, try building with --enable-index." ;
-}
-
-using doxygen ; # Required if you want to use Doxygen.
-using quickbook ;
-
-doxygen top_ref
- :
- [ glob ../../../boost/opaque.hpp ]
- [ glob ../../../boost/opaque/*.hpp ]
 
- #[ glob ../../../boost/opaque/new_class.hpp ]
- #[ glob ../../../boost/opaque/new_type.hpp ]
- #[ glob ../../../boost/opaque/boolean.hpp ]
- #[ glob ../../../boost/opaque/private_opaque_type.hpp ]
- #[ glob ../../../boost/opaque/private_opaque_class.hpp ]
- #[ glob ../../../boost/opaque/public_opaque_type.hpp ]
- #[ glob ../../../boost/opaque/public_opaque_class.hpp ]
- #[ glob ../../../boost/opaque/meta_mixin/linear_hierarchy.hpp ]
- #[ glob ../../../boost/opaque/meta_mixin/inherited_from_underlying.hpp ]
- #[ glob ../../../boost/opaque/meta_mixin/transitive_substituable.hpp ]
- #[ glob ../../../boost/opaque/meta_mixin/transitive_explicit_substituable.hpp ]
- :
+ #doxygen common parameters
         <doxygen:param>"PREDEFINED=\"BOOST_OPAQUE_DOXYGEN_INVOKED=1\" \\
                                    \"BOOST_STATIC_CONSTEXPR=constexpr\" \\
                                    \"BOOST_DEDUCED_TYPENAME=typename\" \\
@@ -120,14 +94,15 @@
         #<doxygen:param>EXPAND_STATIC=YES
         <doxygen:param>SEARCH_INCLUDES=YES
         <doxygen:param>INCLUDE_PATH=$(BOOST)
- <xsl:param>"boost.doxygen.reftitle=Top Level Reference"
- ;
-
-doxygen macros
- :
- [ glob ../../../boost/opaque/macros/*.hpp ]
+
+ ;
+}
+else
+{
+ ECHO "Building the Opaque docs with automatic index generation disabled. To get an auto-index, try building with --enable-index." ;
 
- :
+ project : requirements
+ #doxygen common parameters
         <doxygen:param>"PREDEFINED=\"BOOST_OPAQUE_DOXYGEN_INVOKED=1\" \\
                                    \"BOOST_STATIC_CONSTEXPR=constexpr\" \\
                                    \"BOOST_DEDUCED_TYPENAME=typename\" \\
@@ -180,6 +155,26 @@
         #<doxygen:param>EXPAND_STATIC=YES
         <doxygen:param>SEARCH_INCLUDES=YES
         <doxygen:param>INCLUDE_PATH=$(BOOST)
+
+ ;
+
+}
+
+using doxygen ; # Required if you want to use Doxygen.
+using quickbook ;
+
+doxygen top_ref
+ :
+ [ glob ../../../boost/opaque.hpp ]
+ [ glob ../../../boost/opaque/*.hpp ]
+ :
+ <xsl:param>"boost.doxygen.reftitle=Top Level Reference"
+ ;
+
+doxygen macros
+ :
+ [ glob ../../../boost/opaque/macros/*.hpp ]
+ :
         <xsl:param>"boost.doxygen.reftitle=Macros"
    ;
 
@@ -188,58 +183,6 @@
       [ glob ../../../boost/opaque/meta_mixin/*.hpp ]
 
    :
- <doxygen:param>"PREDEFINED=\"BOOST_OPAQUE_DOXYGEN_INVOKED=1\" \\
- \"BOOST_STATIC_CONSTEXPR=constexpr\" \\
- \"BOOST_DEDUCED_TYPENAME=typename\" \\
- \"BOOST_EXPLICIT=explicit\" \\
- \"BOOST_STATIC_CONSTANT(x,y)=static x const y\" \\
- \"BOOST_STATIC_ASSERT(cnd)=\" \\
- \"BOOST_CONSTEXPR=constexpr\""
-
- <doxygen:param>ALIASES=" Effects=\"<p><b>Effects:</b>\" \\
- Example=\"<p><b>Example:</b>\" \\
- TParams=\"<p><b>Template Parameters:</b>\" \\
- Params=\"<p><b>Parameters:</b>\" \\
- Param{2}=\"<p> - <b><c>\\1</c></b>: \\2.\" \\
- Returns=\"<p><b>Returns:</b>\" \\
- Result=\"<p><b>Result:</b>\" \\
- Throws=\"<p><b>Throws:</b>\" \\
- Pre=\"<p><b>Requires:</b>\" \\
- Requires=\"<p><b>Requires:</b>\" \\
- Post=\"<p><b>Post-conditions:</b>\" \\
- Remark=\"<p><b>Remark(s):</b>\" \\
- Note=\"<p><b>Note(s):</b>\" \\
- See=\"<p><b>See:</b>\" \\
- ThreadSafe=\"<p><b>ThreadSafe:</b> Yes.\" \\
- Basic=\"<p><b>Exception Safety:</b> basic guarantee\" \\
- Strong=\"<p><b>Exception Safety:</b> strong guarantee\" \\
- NoThrow=\"<p><b>Exception Safety:</b> no-throw guarantee\" \\
- RefSect{1}=\"\\xmlonly<link linkend='boost_opaque.\\1'>\\1</link>\\endxmlonly\" \\
- RefSect2{2}=\"\\xmlonly<link linkend='boost_opaque.\\1'>\\2</link>\\endxmlonly\" \\
- RefClass{1}=\"\\xmlonly<computeroutput><classname alt='\\1'>\\1</classname></computeroutput>\\endxmlonly\" \\
- RefMacro{1}=\"\\xmlonly<computeroutput><macroname alt='\\1'>\\1</macroname></computeroutput>\\endxmlonly\" "
-
-
- <doxygen:param>SORT_MEMBER_DOCS=NO
- <doxygen:param>SHOW_USED_FILES=YES
-
- <doxygen:param>SHOW_INCLUDE_FILES=YES
- <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=YES
- <doxygen:param>ENABLE_PREPROCESSING=YES
- <doxygen:param>MACRO_EXPANSION=YES
-
- <doxygen:param>HIDE_UNDOC_MEMBERS=NO
- <doxygen:param>EXTRACT_PRIVATE=NO
- <doxygen:param>EXPAND_ONLY_PREDEF=YES
- #<doxygen:param>EXPAND_STATIC=YES
- <doxygen:param>SEARCH_INCLUDES=YES
- <doxygen:param>INCLUDE_PATH=$(BOOST)
         <xsl:param>"boost.doxygen.reftitle=Meta-Mixins"
    ;
 

Modified: sandbox/opaque/libs/opaque/doc/html/index.html
==============================================================================
--- sandbox/opaque/libs/opaque/doc/html/index.html (original)
+++ sandbox/opaque/libs/opaque/doc/html/index.html 2011-03-30 19:06:18 EDT (Wed, 30 Mar 2011)
@@ -5713,7 +5713,7 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: March 30, 2011 at 21:26:56 GMT</small></p></td>
+<td align="left"><p><small>Last revised: March 30, 2011 at 22:02:05 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>

Date view Thread view Subject view Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk