Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r71517 - in sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc: . Doxygen Editor_syntax_colors Editor_syntax_colors/Textpad html
From: pbristow_at_[hidden]
Date: 2011-04-26 12:14:57

Author: pbristow
Date: 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
New Revision: 71517
URL: http://svn.boost.org/trac/boost/changeset/71517

Log:
First public view. Still needs plenty more work.
Added:
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Acknowledgements.qbk (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/AutoDoxywarnings.log (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/doxywarn.log (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen.css (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_footer.html (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_header.html (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Editor_syntax_colors/
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Editor_syntax_colors/Textpad/
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/autodoc.xml (contents, props changed)
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/html/
   sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/html/boostbook.css (contents, props changed)

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Acknowledgements.qbk
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Acknowledgements.qbk 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,30 @@
+[section:acknowledgements Acknowledgements]
+
+* [@http://oasis-open.org Docbook] authors and maintainers.
+
+* __boostbook (an extension of __docbook) was developed by Douglas Gregor.
+
+* __quickbook was developed by Joel de Guzman and Eric Niebler, and now maintained by Daniel James.
+
+* The link to __doxygen was pioneered by Doug Gregor, and developed by Steven Watanabe.
+
+* Rendering to PDF was made to work by John Maddock.
+
+* Improvements to the tool chain, especially XSLT, by Daniel James and a welcome speedup by Steven Watanabe.
+
+* [@http://www.renderx.com/reference.html RenderX] kindly provide free use of XEP to render the PDF files from XML.
+
+* Automatic Indexing was developed by John Maddock.
+
+* __doxygen is maintained by Dimitri van Heesch.
+It was developed by many people who are acknowledged at the __doxygen site.
+
+[endsect] [/section:acknowledgements Acknowledgements]
+
+[/ Acknowledgements.qbk
+ Copyright 2011 Paul A. Bristow.
+ Distributed under 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).
+]
+

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/AutoDoxywarnings.log
==============================================================================

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/doxywarn.log
==============================================================================

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen.css
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen.css 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,510 @@
+/*
+ The standard CSS for Doxygen but
+ with changed C++ code (syntax) colorization my_doxygen.css */
+/*
+ Copyright Paul A. Bristow 2011
+ Use, modification and distribution are 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)
+*/
+
+body, table, div, p, dl {
+ font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
+ font-size: 12px;
+}
+
+/* @group Heading Levels */
+
+h1 {
+ text-align: center;
+ font-size: 150%;
+}
+
+h2 {
+ font-size: 120%;
+}
+
+h3 {
+ font-size: 100%;
+}
+
+dt {
+ font-weight: bold;
+}
+
+div.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+div.qindex, div.navtab{
+ background-color: #e8eef2;
+ border: 1px solid #84b0c7;
+ text-align: center;
+ margin: 2px;
+ padding: 2px;
+}
+
+div.qindex, div.navpath {
+ width: 100%;
+ line-height: 140%;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a {
+ color: #153788;
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: #1b77c5;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+a.qindex {
+ font-weight: bold;
+}
+
+a.qindexHL {
+ font-weight: bold;
+ background-color: #6666cc;
+ color: #ffffff;
+ border: 1px double #9295C2;
+}
+
+.contents a.qindexHL:visited {
+ color: #ffffff;
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code {
+}
+
+a.codeRef {
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+.fragment {
+ font-family: monospace, fixed;
+ font-size: 105%;
+}
+
+pre.fragment {
+ border: 1px solid #CCCCCC;
+ background-color: #f5f5f5;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+}
+
+div.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ margin-bottom: 6px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background: white;
+ color: black;
+ margin-right: 20px;
+ margin-left: 20px;
+}
+
+td.indexkey {
+ background-color: #e8eef2;
+ font-weight: bold;
+ border: 1px solid #CCCCCC;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+}
+
+td.indexvalue {
+ background-color: #e8eef2;
+ border: 1px solid #CCCCCC;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #f0f0f0;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code (syntax) Colorization */
+
+span.keyword {
+ color: blue
+}
+
+span.keywordtype {
+ color: blue
+}
+
+span.keywordflow {
+ color: blue
+}
+
+span.comment {
+ color: green
+}
+
+span.preprocessor {
+ color: darkblue
+}
+
+span.stringliteral {
+ color: brown
+}
+
+span.charliteral {
+ color: brown
+}
+
+span.operator {
+ color: red
+}
+span.vhdldigit {
+ color: red
+}
+
+span.vhdlchar {
+ color: brown
+}
+
+span.vhdlkeyword {
+ color: blue
+}
+
+span.vhdllogic {
+ color: magenta
+}
+
+/* @end */
+
+.search {
+ color: #003399;
+ font-weight: bold;
+}
+
+form.search {
+ margin-bottom: 0px;
+ margin-top: 0px;
+}
+
+input.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
+}
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #84b0c7;
+}
+
+th.dirtab {
+ background: #e8eef2;
+ font-weight: bold;
+}
+
+hr {
+ height: 0;
+ border: none;
+ border-top: 1px solid #666;
+}
+
+/* @group Member Descriptions */
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #FAFAFA;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memItemLeft, .memItemRight, .memTemplParams {
+ border-top: 1px solid #ccc;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memTemplParams {
+ color: #606060;
+ white-space: nowrap;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation. */
+
+.memtemplate {
+ font-size: 80%;
+ color: #606060;
+ font-weight: normal;
+ margin-left: 3px;
+}
+
+.memnav {
+ background-color: #e8eef2;
+ border: 1px solid #84b0c7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+}
+
+.memname {
+ white-space: nowrap;
+ font-weight: bold;
+}
+
+.memproto, .memdoc {
+ border: 1px solid #84b0c7;
+}
+
+.memproto {
+ padding: 0;
+ background-color: #d5e1e8;
+ font-weight: bold;
+ -webkit-border-top-left-radius: 8px;
+ -webkit-border-top-right-radius: 8px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -moz-border-radius-topleft: 8px;
+ -moz-border-radius-topright: 8px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+
+}
+
+.memdoc {
+ padding: 2px 5px;
+ background-color: #eef3f5;
+ border-top-width: 0;
+ -webkit-border-bottom-left-radius: 8px;
+ -webkit-border-bottom-right-radius: 8px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -moz-border-radius-bottomleft: 8px;
+ -moz-border-radius-bottomright: 8px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+
+/* @end */
+
+/* @group Directory (tree) */
+
+/* for the tree view. */
+
+.ftvtree {
+ font-family: sans-serif;
+ margin: 0.5em;
+}
+
+/* These are for tree view when used as main index. */
+
+.directory {
+ font-size: 9pt;
+ font-weight: bold;
+}
+
+.directory h3 {
+ margin: 0px;
+ margin-top: 1em;
+ font-size: 11pt;
+}
+
+/*
+The following two styles can be used to replace the root node title
+with an image of your choice. Simply uncomment the next two styles,
+specify the name of your image and be sure to set 'height' to the
+proper pixel height of your image.
+*/
+
+/*
+.directory h3.swap {
+ height: 61px;
+ background-repeat: no-repeat;
+ background-image: url("yourimage.gif");
+}
+.directory h3.swap span {
+ display: none;
+}
+*/
+
+.directory > h3 {
+ margin-top: 0;
+}
+
+.directory p {
+ margin: 0px;
+ white-space: nowrap;
+}
+
+.directory div {
+ display: none;
+ margin: 0px;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+/* These are for tree view when not used as main index. */
+
+.directory-alt {
+ font-size: 100%;
+ font-weight: bold;
+}
+
+.directory-alt h3 {
+ margin: 0px;
+ margin-top: 1em;
+ font-size: 11pt;
+}
+
+.directory-alt > h3 {
+ margin-top: 0;
+}
+
+.directory-alt p {
+ margin: 0px;
+ white-space: nowrap;
+}
+
+.directory-alt div {
+ display: none;
+ margin: 0px;
+}
+
+.directory-alt img {
+ vertical-align: -30%;
+}
+
+/* @end */
+
+address {
+ font-style: normal;
+ color: #333;
+}

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_footer.html
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_footer.html 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,29 @@
+-
+
+
+
+
+
+
+<hr size="1"/>
+<table width="100%">
+<tbody>
+ <tr>
+ <address style="text-align: left;">
+ <p>Use, modification and distribution are subject to the Boost Software License, Version 1.0.<br/>
+ (See accompanying file LICENSE_1_0.txt or copy at 
+ http://www.boost.org/LICENSE_1_0.txt )</p>
+ 
+ <p>Copyright © Paul A. Bristow</p>
+ 
+ <p>Doxygen Documentation generated by  doxygen logo $doxygenversion, Revised at $datetime</p>
+ </address>
+ </tr>
+</tbody>
+</table>
+ 
+ 
+ </body> 
+</html>
+
+

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_header.html
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/Doxygen/my_doxygen_header.html 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,40 @@
+
+
+
+-
+
+
+
+
+
+
+
+
+<html> 
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+
+ 
+ <title>Quickbook Doxygen Index Prototype $datetime $projectname $projectnumber</title>
+
+ 
+ <link href="my_doxygen.css" rel="stylesheet" type="text/css"/>
+ 
+ <link href="tabs.css" rel="stylesheet" type="text/css"/>
+</head>
+
+
+<body style="background-image: url(../images/draft.png);"> 
+
+
+<table cellpadding="5" width="100%">
+ <tbody>
+ <tr>
+ <td valign="top"><img alt="Proposed for Boost." src="../../images/proposed_for_boost.png" height="60" width="350"/></td>
+ </tr>
+ </tbody>
+</table>
+<p>
+ <br/> 
+</p>
+

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/autodoc.xml
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/autodoc.xml 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,50 @@
+<?xml version="1.0" standalone="yes"?>
+<library-reference id="quickbookdoxygenautoindex_reference"><title>QuickbookDoxygenAutoindex Reference</title><header name="boost/quick_auto_dox_index/detail/FP_compare.hpp"><para>Two types of floating-point comparison "Very close" and "Close enough" to a chosen tolerance. </para><para>Derived from Boost.Test Copyright Gennadiy Rozental 2001-2007. See <ulink url="http://www.boost.org/libs/test">http://www.boost.org/libs/test> for the Boost.Test library home page. Deliberately removed any treatment of percent to avoid further potential confusion! <para>Mar 2009 </para>
+<para>Paul A. Bristow </para>
+</para><class name="close_to"><template>
+ <template-type-parameter name="FPT"><default>double</default><purpose><para>floating-point type.</para></purpose></template-type-parameter>
+ </template><purpose>Test if two floating-point values are close within a chosen tolerance. </purpose><description><para>
+Close can be one of two types of floating-point comparison "Very close" and "Close enough". equations in Dougles E. Knuth, Seminumerical algorithms (3rd Ed) section 4.2.4, Vol II, pp 213-225, Addison-Wesley, 1997, ISBN: 0201896842. Strong requires closeness relative to BOTH values begin compared, Weak only requires only closeness to EITHER ONE value. </para></description><method-group name="public member functions"><method name="operator()" cv="const"><type>bool</type><parameter name="left"><paramtype>FPT</paramtype></parameter><parameter name="right"><paramtype>FPT</paramtype></parameter><description><para>Test if two floating-point values are close within a chosen tolerance.</para><para>Tolerance can be interpreted as Knuth's "Very close" (equation 1), the default, or "Close enough" (equation 2). </para></description></method><method name="size" cv=""><type>FPT</type><description><para>
+</para></description><returns><para>the chosen tolerance, as a <emphasis role="bold">fraction</emphasis> (not a percentage). </para></returns></method><method name="strength" cv=""><type>floating_point_comparison_type</type><description><para>
+</para></description><returns><para>strength of comparison, Knuth's "Very close" (equation 1), the default, or "Close enough" (equation 2). </para></returns></method></method-group><constructor specifiers="explicit"><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name="tolerance"><paramtype>FPT</paramtype></parameter><parameter name="fpc_type"><paramtype>floating_point_comparison_type</paramtype><default>FPC_STRONG</default></parameter><purpose>Constructor for <classname alt="close_to">close_to</classname> from tolerance and strength. (By design, percent is NOT implemented). </purpose></constructor><constructor><description><para>Default is two epsilon for the FPT.<sbr/>
+ Note that some user-defined floating-point types may not specialize std::numeric_limits<FPT>::epsilon() so it is convenient to use boost::math::tools::epsilon<FPT>(); instead.</para></description></constructor></class><class name="smallest"><template>
+ <template-type-parameter name="FPT"><default>double</default><purpose><para>A floating-point type, float, double, long double or user-defined like NTL quad_float or RR. </para></purpose></template-type-parameter>
+ </template><purpose>Check floating-point value is smaller than a chosen small value, default is twice min_value() for the floating-point type FPT. </purpose><description><para>It is somewhat common for beginners to add a comparison check to 0 before computing a division, in order to avoid possible division-by-zero exceptions or the generation of infinite results.<sbr/>
+ A first objection to this practise is that, anyway, computing 1/x for x very close to zero will generate very large numbers that will most probably result in overflows later.<sbr/>
+ Another objection, which few programmers know about and that we wish to draw attention to, is that it may actually fail to work, depending on what the compiler does, that is, the program may actually test that x == 0, then, further down, find that x = 0 without any apparent change to x!<sbr/>
+ David Monniaux, <ulink url="http://arxiv.org/abs/cs/0701192v4.">http://arxiv.org/abs/cs/0701192v4.>
+</para></description><method-group name="public member functions"><method name="operator()" cv=""><type>bool</type><parameter name="fp_value"><paramtype>FPT</paramtype></parameter><parameter name="s"><paramtype>FPT</paramtype></parameter><description><para>True if value is smaller than a smallest value s. </para></description></method><method name="operator()" cv=""><type>bool</type><parameter name="fp_value"><paramtype>FPT</paramtype></parameter><description><para>True if value is smaller than chosen smallest value. </para></description></method><method name="size" cv=""><type>FPT</type><description><para>
+</para></description><returns><para>chosen smallest value that will be counted as effectively zero. </para></returns></method></method-group><constructor specifiers="explicit"><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name="s"><paramtype>FPT</paramtype></parameter><description><para>Constructor with user defined value of smallest, for example 10 * min_value<FPT>. Note that some user-defined floating-point types may not specialize std::numeric_limits<FPT>::min_value() so it is convenient to use boost::math::tools::min_value<FPT>(); instead.</para></description></constructor><constructor><description><para>Default Constructor with smallest_ = 2. * boost::math::tools::min_value<double>();<sbr/>
+ multiplier m = 2 (must be integer or static_cast<FPT>()) is chosen to allow for a few bits of computation error.<sbr/>
+ Pessimistic multiplier is the number of arithmetic operations, assuming every operation causes a 1 least significant bit error, but a more realistic average might be half this.</para></description></constructor></class><typedef name="neareq"><purpose>Allow neareq as a shorthand for twice double epsilon = 4.44e-16. </purpose><description><para>Since double and the default <classname alt="close_to">close_to</classname> value 2 * epsilon = std::numeric_limits<double>::epsilon = 2 * 2.220446e-016 = 4.440892e-016 is a very common requirement, provide an convenience alias for this. </para></description><type><classname>close_to</classname>< double ></type></typedef><typedef name="tiny"><purpose>Allow tiny as a shorthand for twice the double min_value 4.45e-308. </purpose><description><para>Since double and the default smallest value 2 * std::numeric_limits<double>::min_value() = 2 * 2.22507e-308 + 4.45015e-308 is a very common requirement, provide an convenience alias for this. </para></descrip
tion><type><classname>smallest</classname>< double ></type></typedef><function name="epsilon"><type>FPT</type><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name=""><paramtype>FPT</paramtype></parameter><purpose>epsilon for type T (about 1e-16 for double) </purpose></function><function name="fpt_abs"><type>FPT</type><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name="arg"><paramtype>FPT</paramtype></parameter><description><para>abs function (just in case abs is not defined for a user-defined FPT). </para></description></function><function name="max_value"><type>FPT</type><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name=""><paramtype>FPT</paramtype></parameter><purpose>maximum value for floating-point type T. </purpose></function><function name="min_value"><type>FPT</type><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name=""><paramtype>FPT</paramtype></parameter><purpose>minimum value for floating-point type T. </purpose></function><function name="safe_fpt_division"><type>FPT</type><template>
+ <template-type-parameter name="FPT"/>
+ </template><parameter name="f1"><paramtype>FPT</paramtype></parameter><parameter name="f2"><paramtype>FPT</paramtype></parameter><description><para>Division safe from underflow and overflow. (Both f1 and f2 must be unsigned here). </para></description></function></header><header name="boost/quick_auto_dox_index/quick_auto_dox_index.hpp"><para>Template for documentation. </para><para>Example file for creating Boost documentation using Quickbook, Doxygen and Auto-Indexing. Example code with comment taken from /doxygen/html/docblocks.html using Boost naming conventions. <sbr/>
+ The style of this example takes a lot of lines, so other Boost-style examples are much more compact. They do rely on syntax coloring to make the comments stand clear and not obscure the real C++ code.</para><para><para>Mar 2011 </para>
+<para>Paul A. Bristow </para>
+</para><class name="test"><purpose>A test class - a comment description that preceeds the class. </purpose><description><para>a class by comment that is tucked in under the class (to reduce the line count). BUT you must explicitly link to the class or it will be applied to the next member. Using a < doesn't work for classes as it does for members. </para></description><enum name="test_enum"><enumvalue name="test_enum_val1"><purpose>Enum value TVal1 (Note the < to link to the same line). </purpose></enumvalue><enumvalue name="test_enum_val2"><purpose>Enum value TVal2. (Using C++ // comment markers, and < to link to the same line. </purpose></enumvalue><enumvalue name="test_enum_val3"><description><para>Enum value TVal3. (using C style comment markers). </para></description></enumvalue><purpose>Example of documenting an enum. </purpose><description><para>More detailed enum description. This description needs more than one line, so convenient to use C style comment markers. </para></description></enum
><data-member name="handler"><type>int(*</type><purpose>A function variable. </purpose><description><para>Details about what the function does. <para>This is an implementation detail and not for user code. </para>
+
+
+</para></description></data-member><data-member name="public_var"><type>int</type><purpose>A public variable. </purpose><description><para>Details about the variable. </para></description></data-member><method-group name="public member functions"><method name="test_me" cv=""><type>int</type><parameter name="a"><paramtype>int</paramtype><description><para>an integer argument. </para></description></parameter><parameter name="s"><paramtype>const char *</paramtype><description><para>a constant character pointer. </para></description></parameter><purpose>A normal member function taking two arguments and returning an integer value. </purpose><description><para>
+
+
+
+<para><emphasis role="bold">See Also:</emphasis><para>Test(), ~Test(), testMeToo() and publicVar() </para></para>
+</para></description><requires><para>No preconditions. </para></requires><postconditions><para>No side effects. </para></postconditions><returns><para>The test result. </para></returns></method><method name="test_me_too" cv=""><type>void</type><parameter name="c1"><paramtype>char</paramtype><description><para>the first argument. </para></description></parameter><parameter name="c2"><paramtype>char</paramtype><description><para>the second argument. </para></description></parameter><description><para>A pure virtual member with descriptions of parameters. And a 'see also' reference to another version of the function.</para><para><para><emphasis role="bold">See Also:</emphasis><para>test_me() </para></para>
+<xrefsect id="deprecated_1_deprecated000001"><xreftitle>Deprecated</xreftitle><xrefdescription><para>Will be removed in the next but one version. Use test_me() instead. </para></xrefdescription></xrefsect>
+
+</para></description><returns><para>The test result. </para></returns></method></method-group><constructor><purpose>A constructor. </purpose><description><para>A more elaborate description of the constructor. </para></description></constructor><destructor><purpose>A destructor. </purpose><description><para>A more elaborate description of the destructor.
+
+<para>This descructor may blow up? </para>
+</para></description><requires><para>No preconditions. </para></requires><postconditions><para>A test object constructed, with no side effects. </para></postconditions></destructor></class></header></library-reference>

Added: sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/html/boostbook.css
==============================================================================
--- (empty file)
+++ sandbox/tools/quick_auto_dox_index/libs/quick_auto_dox_index/doc/html/boostbook.css 2011-04-26 12:14:55 EDT (Tue, 26 Apr 2011)
@@ -0,0 +1,601 @@
+/*=============================================================================
+ Copyright (c) 2004 Joel de Guzman
+ http://spirit.sourceforge.net/
+
+ Distributed under the Boost Software License, Version 1.0. (See accompany-
+ ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================*/
+
+/*=============================================================================
+ Body defaults
+=============================================================================*/
+
+ body
+ {
+ margin: 1em;
+ font-family: sans-serif;
+ }
+
+/*=============================================================================
+ Paragraphs
+=============================================================================*/
+
+ p
+ {
+ text-align: left;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+/*=============================================================================
+ Program listings
+=============================================================================*/
+
+ /* Code on paragraphs */
+ p tt.computeroutput
+ {
+ font-size: 9pt;
+ }
+
+ pre.synopsis
+ {
+ font-size: 9pt;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ .programlisting,
+ .screen
+ {
+ font-size: 9pt;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ /* Program listings in tables don't get borders */
+ td .programlisting,
+ td .screen
+ {
+ margin: 0pc 0pc 0pc 0pc;
+ padding: 0pc 0pc 0pc 0pc;
+ }
+
+/*=============================================================================
+ Headings
+=============================================================================*/
+
+ h1, h2, h3, h4, h5, h6
+ {
+ text-align: left;
+ margin: 1em 0em 0.5em 0em;
+ font-weight: bold;
+ }
+
+ h1 { font: 140% }
+ h2 { font: bold 140% }
+ h3 { font: bold 130% }
+ h4 { font: bold 120% }
+ h5 { font: italic 110% }
+ h6 { font: italic 100% }
+
+ /* Top page titles */
+ title,
+ h1.title,
+ h2.title
+ h3.title,
+ h4.title,
+ h5.title,
+ h6.title,
+ .refentrytitle
+ {
+ font-weight: bold;
+ margin-bottom: 1pc;
+ }
+
+ h1.title { font-size: 140% }
+ h2.title { font-size: 140% }
+ h3.title { font-size: 130% }
+ h4.title { font-size: 120% }
+ h5.title { font-size: 110% }
+ h6.title { font-size: 100% }
+
+ .section h1
+ {
+ margin: 0em 0em 0.5em 0em;
+ font-size: 140%;
+ }
+
+ .section h2 { font-size: 140% }
+ .section h3 { font-size: 130% }
+ .section h4 { font-size: 120% }
+ .section h5 { font-size: 110% }
+ .section h6 { font-size: 100% }
+
+ /* Code on titles */
+ h1 tt.computeroutput { font-size: 140% }
+ h2 tt.computeroutput { font-size: 140% }
+ h3 tt.computeroutput { font-size: 130% }
+ h4 tt.computeroutput { font-size: 130% }
+ h5 tt.computeroutput { font-size: 130% }
+ h6 tt.computeroutput { font-size: 130% }
+
+
+/*=============================================================================
+ Author
+=============================================================================*/
+
+ h3.author
+ {
+ font-size: 100%
+ }
+
+/*=============================================================================
+ Lists
+=============================================================================*/
+
+ li
+ {
+ font-size: 10pt;
+ line-height: 1.3;
+ }
+
+ /* Unordered lists */
+ ul
+ {
+ text-align: left;
+ }
+
+ /* Ordered lists */
+ ol
+ {
+ text-align: left;
+ }
+
+/*=============================================================================
+ Links
+=============================================================================*/
+
+ a
+ {
+ text-decoration: none; /* no underline */
+ }
+
+ a:hover
+ {
+ text-decoration: underline;
+ }
+
+/*=============================================================================
+ Spirit style navigation
+=============================================================================*/
+
+ .spirit-nav
+ {
+ text-align: right;
+ }
+
+ .spirit-nav a
+ {
+ color: white;
+ padding-left: 0.5em;
+ }
+
+ .spirit-nav img
+ {
+ border-width: 0px;
+ }
+
+/*=============================================================================
+ Copyright footer
+=============================================================================*/
+ .copyright-footer
+ {
+ text-align: right;
+ font-size: 70%;
+ }
+
+ .copyright-footer p
+ {
+ text-align: right;
+ font-size: 80%;
+ }
+
+/*=============================================================================
+ Table of contents
+=============================================================================*/
+
+ .toc
+ {
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.1pc 1pc 0.1pc 1pc;
+ font-size: 80%;
+ line-height: 1.15;
+ }
+
+ .boost-toc
+ {
+ float: right;
+ padding: 0.5pc;
+ }
+
+ /* Code on toc */
+ .toc .computeroutput { font-size: 120% }
+
+/*=============================================================================
+ Tables
+=============================================================================*/
+
+ .table-title,
+ div.table p.title
+ {
+ margin-left: 4%;
+ padding-right: 0.5em;
+ padding-left: 0.5em;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ width: 92%;
+ margin-left: 4%;
+ margin-right: 4%;
+ }
+
+ div.informaltable table,
+ div.table table
+ {
+ padding: 4px;
+ }
+
+ /* Table Cells */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ padding: 0.5em;
+ text-align: left;
+ font-size: 9pt;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ border: 1pt solid white;
+ font-size: 80%;
+ }
+
+ table.simplelist
+ {
+ width: auto !important;
+ margin: 0em !important;
+ padding: 0em !important;
+ border: none !important;
+ }
+ table.simplelist td
+ {
+ margin: 0em !important;
+ padding: 0em !important;
+ text-align: left !important;
+ font-size: 9pt !important;
+ border: none !important;
+ }
+
+/*=============================================================================
+ Blurbs
+=============================================================================*/
+
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ font-size: 9pt; /* A little bit smaller than the main text */
+ line-height: 1.2;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ p.blurb img
+ {
+ padding: 1pt;
+ }
+
+/*=============================================================================
+ Variable Lists
+=============================================================================*/
+
+ div.variablelist
+ {
+ margin: 1em 0;
+ }
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt,
+ span.term
+ {
+ font-weight: bold;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td
+ {
+ text-align: left;
+ vertical-align: top;
+ padding: 0em 2em 0em 0em;
+ font-size: 10pt;
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+ div.variablelist dl dt
+ {
+ margin-bottom: 0.2em;
+ }
+
+ div.variablelist dl dd
+ {
+ margin: 0em 0em 0.5em 2em;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td p,
+ div.variablelist dl dd p
+ {
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+/*=============================================================================
+ Misc
+=============================================================================*/
+
+ /* Title of books and articles in bibliographies */
+ span.title
+ {
+ font-style: italic;
+ }
+
+ span.underline
+ {
+ text-decoration: underline;
+ }
+
+ span.strikethrough
+ {
+ text-decoration: line-through;
+ }
+
+ /* Copyright, Legal Notice */
+ div div.legalnotice p
+ {
+ text-align: left
+ }
+
+/*=============================================================================
+ Colors
+=============================================================================*/
+
+ @media screen
+ {
+ body {
+ background-color: #FFFFFF;
+ color: #000000;
+ }
+
+ /* Syntax Highlighting */
+ .keyword { color: #0000AA; }
+ .identifier { color: #000000; }
+ .special { color: #707070; }
+ .preprocessor { color: #402080; }
+ .char { color: teal; }
+ .comment { color: #800000; }
+ .string { color: teal; }
+ .number { color: teal; }
+ .white_bkd { background-color: #FFFFFF; }
+ .dk_grey_bkd { background-color: #999999; }
+
+ /* Links */
+ a, a .keyword, a .identifier, a .special, a .preprocessor
+ a .char, a .comment, a .string, a .number
+ {
+ color: #005a9c;
+ }
+
+ a:visited, a:visited .keyword, a:visited .identifier,
+ a:visited .special, a:visited .preprocessor a:visited .char,
+ a:visited .comment, a:visited .string, a:visited .number
+ {
+ color: #9c5a9c;
+ }
+
+ h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
+ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
+ h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
+ {
+ text-decoration: none; /* no underline */
+ color: #000000;
+ }
+
+ /* Copyright, Legal Notice */
+ .copyright
+ {
+ color: #666666;
+ font-size: small;
+ }
+
+ div div.legalnotice p
+ {
+ color: #666666;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Blurbs */
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ background-color: #F0F0F0;
+ border: 1px solid #DCDCDC;
+ }
+
+ .copyright-footer
+ {
+ color: #8F8F8F;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ color: #00A000;
+ }
+ }
+
+ @media print
+ {
+ /* Links */
+ a
+ {
+ color: black;
+ }
+
+ a:visited
+ {
+ color: black;
+ }
+
+ .spirit-nav
+ {
+ display: none;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid gray;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid gray;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid gray;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ border: 1px solid gray;
+ border-collapse: collapse;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid gray;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ border: 1px solid gray;
+ }
+
+ table.simplelist tr td
+ {
+ border: none !important;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ font-weight: bold;
+ }
+ }
+
+/*=============================================================================
+ Images
+=============================================================================*/
+
+ span.inlinemediaobject img
+ {
+ vertical-align: middle;
+ }
+
+/*==============================================================================
+ Super and Subscript: style so that line spacing isn't effected, see
+ http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341
+==============================================================================*/
+
+sup,
+sub {
+ height: 0;
+ line-height: 1;
+ vertical-align: baseline;
+ _vertical-align: bottom;
+ position: relative;
+
+}
+
+sup {
+ bottom: 1ex;
+}
+
+sub {
+ top: .5ex;
+}
+

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