|
|
Boost-Commit : |
From: joel_at_[hidden]
Date: 2007-09-24 02:03:14
Author: djowel
Date: 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
New Revision: 39497
URL: http://svn.boost.org/trac/boost/changeset/39497
Log:
added new import syntax for ignoring code.
Text files modified:
trunk/tools/quickbook/block.hpp | 2
trunk/tools/quickbook/code_snippet.hpp | 5
trunk/tools/quickbook/doc/html/index.html | 2
trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html | 38 +++-----
trunk/tools/quickbook/doc/html/quickbook/faq.html | 2
trunk/tools/quickbook/doc/html/quickbook/ref.html | 2
trunk/tools/quickbook/doc/html/quickbook/syntax/block.html | 170 +++++++++++++++------------------------
trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html | 88 ++++++-------------
trunk/tools/quickbook/doc/quickbook.qbk | 10 +
9 files changed, 121 insertions(+), 198 deletions(-)
Modified: trunk/tools/quickbook/block.hpp
==============================================================================
--- trunk/tools/quickbook/block.hpp (original)
+++ trunk/tools/quickbook/block.hpp 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -386,7 +386,7 @@
;
paragraph_end =
- '[' >> space >> paragraph_end_markups | eol >> eol
+ '[' >> space >> paragraph_end_markups >> hard_space | eol >> eol
;
paragraph =
Modified: trunk/tools/quickbook/code_snippet.hpp
==============================================================================
--- trunk/tools/quickbook/code_snippet.hpp (original)
+++ trunk/tools/quickbook/code_snippet.hpp 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -72,7 +72,10 @@
*blank_p >> "//<-"
>> (*(anychar_p - "//->"))
>> "//->" >> *blank_p >> eol_p
- | "/*<-"
+ | "/*<-*/"
+ >> (*(anychar_p - "/*->*/"))
+ >> "/*->*/"
+ | "/*<-"
>> (*(anychar_p - "->*/"))
>> "->*/"
;
Modified: trunk/tools/quickbook/doc/html/index.html
==============================================================================
--- trunk/tools/quickbook/doc/html/index.html (original)
+++ trunk/tools/quickbook/doc/html/index.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -70,7 +70,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: August 01, 2007 at 23:43:11 GMT</small></p></td>
+<td align="left"><p><small>Last revised: September 24, 2007 at 06:00:48 GMT</small></p></td>
<td align="right"><small></small></td>
</tr></table>
<hr>
Modified: trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/editors/kde_support.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -26,7 +26,7 @@
<div class="titlepage"><div><div><h3 class="title">
<a name="quickbook.editors.kde_support"></a>KDE Support</h3></div></div></div>
<a name="quickbook.editors.kde_support.boost__hs__quickbook"></a><h4>
-<a name="id466174"></a>
+<a name="id466294"></a>
<a href="kde_support.html#quickbook.editors.kde_support.boost__hs__quickbook">boost::hs::quickbook</a>
</h4>
<p>
@@ -51,7 +51,7 @@
<span class="bold"><b>html generated from this .qbk file</b></span>
</p>
<div class="table">
-<a name="id466275"></a><p class="title"><b>Table 7. Code examples</b></p>
+<a name="id466395"></a><p class="title"><b>Table 7. Code examples</b></p>
<table class="table" summary="Code examples">
<colgroup>
<col>
@@ -140,7 +140,7 @@
</table>
</div>
<a name="quickbook.editors.kde_support.code_folding_"></a><h4>
-<a name="id466682"></a>
+<a name="id466802"></a>
<a href="kde_support.html#quickbook.editors.kde_support.code_folding_">Code Folding
</a>
</h4>
@@ -150,7 +150,7 @@
region can be folded or unfolded independently.
</p>
<a name="quickbook.editors.kde_support.auto_comment___uncomment_"></a><h4>
-<a name="id466714"></a>
+<a name="id466834"></a>
<a href="kde_support.html#quickbook.editors.kde_support.auto_comment___uncomment_">Auto
Comment / Uncomment </a>
</h4>
@@ -161,7 +161,7 @@
while being in it.
</p>
<a name="quickbook.editors.kde_support.styles_reference_"></a><h4>
-<a name="id466756"></a>
+<a name="id466876"></a>
<a href="kde_support.html#quickbook.editors.kde_support.styles_reference_">Styles reference
</a>
</h4>
@@ -398,7 +398,7 @@
</tbody>
</table></div>
<a name="quickbook.editors.kde_support.about_boost__hs"></a><h4>
-<a name="id467204"></a>
+<a name="id467324"></a>
<a href="kde_support.html#quickbook.editors.kde_support.about_boost__hs">About boost::hs</a>
</h4>
<p>
@@ -414,18 +414,12 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- boost::hs::cpp support QuickBook code import comments style!
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ boost::hs::cpp support QuickBook code import comments style!
+ </p></td></tr>
</table></div>
<a name="quickbook.editors.kde_support.installing_boost__hs"></a><h4>
-<a name="id467275"></a>
+<a name="id467392"></a>
<a href="kde_support.html#quickbook.editors.kde_support.installing_boost__hs">Installing
boost::hs</a>
</h4>
@@ -442,15 +436,9 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- A copy of boost::hs::quickbook and boost::hs::cpp is available in <tt class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span><span class="special">/</span><span class="identifier">extra</span><span class="special">/</span><span class="identifier">katepart</span></tt>.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ A copy of boost::hs::quickbook and boost::hs::cpp is available in <tt class="computeroutput"><span class="identifier">boost</span><span class="special">/</span><span class="identifier">tools</span><span class="special">/</span><span class="identifier">quickbook</span><span class="special">/</span><span class="identifier">extra</span><span class="special">/</span><span class="identifier">katepart</span></tt>.
+ </p></td></tr>
</table></div>
<p>
In order to install it you must copy the content in the folder <span class="bold"><b>katepart/syntax/</b></span> to the appropriate katepart syntax
Modified: trunk/tools/quickbook/doc/html/quickbook/faq.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/faq.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/faq.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -26,7 +26,7 @@
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="quickbook.faq"></a> Frequently Asked Questions</h2></div></div></div>
<a name="quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_"></a><h3>
-<a name="id467431"></a>
+<a name="id467544"></a>
<a href="faq.html#quickbook.faq.can_i_use_quickbook_for_non_boost_documentation_">Can
I use QuickBook for non-Boost documentation?</a>
</h3>
Modified: trunk/tools/quickbook/doc/html/quickbook/ref.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/ref.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/ref.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -28,7 +28,7 @@
[cpp]
</p>
<div class="table">
-<a name="id467529"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
+<a name="id467642"></a><p class="title"><b>Table 8. Syntax Compendium</b></p>
<table class="table" summary="Syntax Compendium">
<colgroup>
<col>
Modified: trunk/tools/quickbook/doc/html/quickbook/syntax/block.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/block.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax/block.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -587,75 +587,45 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- This is a note
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ This is a note
+ </p></td></tr>
</table></div>
<div class="tip"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/html/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- This is a tip
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ This is a tip
+ </p></td></tr>
</table></div>
<div class="important"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../../doc/html/images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- This is important
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ This is important
+ </p></td></tr>
</table></div>
<div class="caution"><table border="0" summary="Caution">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../doc/html/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- This is a caution
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ This is a caution
+ </p></td></tr>
</table></div>
<div class="warning"><table border="0" summary="Warning">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- This is a warning
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ This is a warning
+ </p></td></tr>
</table></div>
<p>
These are the only admonitions supported by DocBook.
@@ -674,27 +644,27 @@
[h6 Heading 6]
</pre>
<a name="quickbook.syntax.block.headings.heading_1"></a><h1>
-<a name="id459586"></a>
+<a name="id459550"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_1">Heading 1</a>
</h1>
<a name="quickbook.syntax.block.headings.heading_2"></a><h2>
-<a name="id459611"></a>
+<a name="id459574"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_2">Heading 2</a>
</h2>
<a name="quickbook.syntax.block.headings.heading_3"></a><h3>
-<a name="id459635"></a>
+<a name="id459598"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_3">Heading 3</a>
</h3>
<a name="quickbook.syntax.block.headings.heading_4"></a><h4>
-<a name="id459660"></a>
+<a name="id459623"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_4">Heading 4</a>
</h4>
<a name="quickbook.syntax.block.headings.heading_5"></a><h5>
-<a name="id459685"></a>
+<a name="id459648"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_5">Heading 5</a>
</h5>
<a name="quickbook.syntax.block.headings.heading_6"></a><h5>
-<a name="id459710"></a>
+<a name="id459673"></a>
<a href="block.html#quickbook.syntax.block.headings.heading_6">Heading 6</a>
</h5>
<p>
@@ -787,18 +757,12 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../../doc/html/images/tip.png"></td>
<th align="left">Tip</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- It's a good idea to use macro identifiers that are distinguishable.
- For instance, in this document, macro identifiers have two leading
- and trailing underscores (e.g. <tt class="literal">__spirit__</tt>). The reason is
- to avoid unwanted macro replacement.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ It's a good idea to use macro identifiers that are distinguishable. For
+ instance, in this document, macro identifiers have two leading and trailing
+ underscores (e.g. <tt class="literal">__spirit__</tt>). The reason is to avoid unwanted
+ macro replacement.
+ </p></td></tr>
</table></div>
<p>
Links (URLS) and images are good candidates for macros. <span class="bold"><b>1</b></span>)
@@ -838,7 +802,7 @@
Quickbook has some predefined macros that you can already use.
</p>
<div class="table">
-<a name="id460170"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
+<a name="id460123"></a><p class="title"><b>Table 3. Predefined Macros</b></p>
<table class="table" summary="Predefined Macros">
<colgroup>
<col>
@@ -876,7 +840,7 @@
</td>
<td>
<p>
- 2007-Aug-02
+ 2007-Sep-24
</p>
</td>
</tr>
@@ -893,7 +857,7 @@
</td>
<td>
<p>
- 07:43:11 AM
+ 02:00:48 PM
</p>
</td>
</tr>
@@ -939,7 +903,7 @@
]
</pre>
<a name="quickbook.syntax.block.templates.template_identifier"></a><h5>
-<a name="id460350"></a>
+<a name="id460303"></a>
<a href="block.html#quickbook.syntax.block.templates.template_identifier">Template
Identifier</a>
</h5>
@@ -957,7 +921,7 @@
</li>
</ul></div>
<a name="quickbook.syntax.block.templates.formal_template_arguments"></a><h5>
-<a name="id460397"></a>
+<a name="id460350"></a>
<a href="block.html#quickbook.syntax.block.templates.formal_template_arguments">Formal
Template Arguments</a>
</h5>
@@ -977,7 +941,7 @@
of the template call.
</p>
<a name="quickbook.syntax.block.templates.template_body"></a><h5>
-<a name="id460516"></a>
+<a name="id460469"></a>
<a href="block.html#quickbook.syntax.block.templates.template_body">Template
Body</a>
</h5>
@@ -1002,7 +966,7 @@
block level elements are not allowed in phrase templates.
</p>
<a name="quickbook.syntax.block.templates.template_expansion"></a><h5>
-<a name="id460575"></a>
+<a name="id460528"></a>
<a href="block.html#quickbook.syntax.block.templates.template_expansion">Template
Expansion</a>
</h5>
@@ -1038,19 +1002,13 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../../../doc/html/images/caution.png"></td>
<th align="left">Caution</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- A word of caution: Templates are recursive. A template can call another
- template or even itself, directly or indirectly. There are no control
- structures in QuickBook (yet) so this will always mean infinite recursion.
- QuickBook can detect this situation and report an error if recursion
- exceeds a certain limit.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ A word of caution: Templates are recursive. A template can call another
+ template or even itself, directly or indirectly. There are no control
+ structures in QuickBook (yet) so this will always mean infinite recursion.
+ QuickBook can detect this situation and report an error if recursion
+ exceeds a certain limit.
+ </p></td></tr>
</table></div>
<p>
Each actual argument can be a word, a text fragment or just about any
@@ -1059,7 +1017,7 @@
by the close parenthesis.
</p>
<a name="quickbook.syntax.block.templates.nullary_templates"></a><h5>
-<a name="id460678"></a>
+<a name="id460634"></a>
<a href="block.html#quickbook.syntax.block.templates.nullary_templates">Nullary
Templates</a>
</h5>
@@ -1142,7 +1100,7 @@
brackets, though.
</p>
<a name="quickbook.syntax.block.templates.simple_arguments"></a><h5>
-<a name="id460912"></a>
+<a name="id385004"></a>
<a href="block.html#quickbook.syntax.block.templates.simple_arguments">Simple
Arguments</a>
</h5>
@@ -1210,7 +1168,7 @@
what do you think man?
</p>
<a name="quickbook.syntax.block.templates.punctuation_templates"></a><h5>
-<a name="id461083"></a>
+<a name="id461175"></a>
<a href="block.html#quickbook.syntax.block.templates.punctuation_templates">Punctuation
Templates</a>
</h5>
@@ -1266,16 +1224,10 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- Prefer admonitions
- wherever appropriate.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ Prefer admonitions
+ wherever appropriate.
+ </p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -1292,7 +1244,7 @@
will generate:
</p>
<div class="table">
-<a name="id461289"></a><p class="title"><b>Table 4. A Simple Table</b></p>
+<a name="id461378"></a><p class="title"><b>Table 4. A Simple Table</b></p>
<table class="table" summary="A Simple Table">
<colgroup>
<col>
@@ -1403,7 +1355,7 @@
and thus:
</p>
<div class="table">
-<a name="id461453"></a><p class="title"><b>Table 5. Table with fat cells</b></p>
+<a name="id461542"></a><p class="title"><b>Table 5. Table with fat cells</b></p>
<table class="table" summary="Table with fat cells">
<colgroup>
<col>
@@ -1478,7 +1430,7 @@
]
</pre>
<div class="table">
-<a name="id461571"></a><p class="title"><b>Table 6. Table with code</b></p>
+<a name="id461660"></a><p class="title"><b>Table 6. Table with code</b></p>
<table class="table" summary="Table with code">
<colgroup>
<col>
@@ -1618,7 +1570,7 @@
QuickBook's import facility provides a nice solution.
</p>
<a name="quickbook.syntax.block.import.example"></a><h5>
-<a name="id461995"></a>
+<a name="id462084"></a>
<a href="block.html#quickbook.syntax.block.import.example">Example</a>
</h5>
<p>
@@ -1724,7 +1676,7 @@
<p>
</p>
<a name="quickbook.syntax.block.import.code_snippet_markup"></a><h5>
-<a name="id462307"></a>
+<a name="id462396"></a>
<a href="block.html#quickbook.syntax.block.import.code_snippet_markup">Code
Snippet Markup</a>
</h5>
@@ -1745,7 +1697,7 @@
This too will not be visible in quickbook.
</p>
<a name="quickbook.syntax.block.import.special_comments"></a><h5>
-<a name="id462433"></a>
+<a name="id462522"></a>
<a href="block.html#quickbook.syntax.block.import.special_comments">Special
Comments</a>
</h5>
@@ -1771,23 +1723,29 @@
Special comments of the form:
</p>
<pre class="programlisting">
-<span class="comment">/*<-- this will be ignored -->*/</span>
+<span class="comment">/*<- this C++ comment will be ignored ->*/</span>
+</pre>
+<p>
+ or
+ </p>
+<pre class="programlisting">
+<span class="comment">/*<-*/</span> <span class="string">"this c++ code will be ignored"</span> <span class="comment">/*->*/</span>
</pre>
<p>
or
</p>
<pre class="programlisting">
-<span class="comment">//<--
+<span class="comment">//<-
</span><span class="keyword">private</span><span class="special">:</span>
<span class="keyword">int</span> <span class="identifier">some_member</span><span class="special">;</span>
-<span class="comment">//-->
+<span class="comment">//->
</span></pre>
<p>
can be used to inhibit code from passing through to quickbook. All text
between the delimeters will simply be ignored.
</p>
<a name="quickbook.syntax.block.import.callouts"></a><h5>
-<a name="id462581"></a>
+<a name="id462702"></a>
<a href="block.html#quickbook.syntax.block.import.callouts">Callouts</a>
</h5>
<p>
Modified: trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html
==============================================================================
--- trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html (original)
+++ trunk/tools/quickbook/doc/html/quickbook/syntax/phrase.html 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -412,17 +412,11 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- We simply enclose the code with the tick: <tt class="literal">"`"</tt>, not
- the single quote: <tt class="computeroutput"><span class="string">"'"</span></tt>.
- Note too that <tt class="literal">`some code`</tt> is preferred over <tt class="literal">[^some code]</tt>.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ We simply enclose the code with the tick: <tt class="literal">"`"</tt>, not the
+ single quote: <tt class="computeroutput"><span class="string">"'"</span></tt>.
+ Note too that <tt class="literal">`some code`</tt> is preferred over <tt class="literal">[^some code]</tt>.
+ </p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -501,7 +495,7 @@
whereas a Python comment <tt class="computeroutput"><span class="comment">#looks like this</span></tt>.
</p>
<div class="table">
-<a name="id456959"></a><p class="title"><b>Table 2. Supported Source Modes</b></p>
+<a name="id456956"></a><p class="title"><b>Table 2. Supported Source Modes</b></p>
<table class="table" summary="Supported Source Modes">
<colgroup>
<col>
@@ -552,15 +546,9 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/html/images/note.png"></td>
<th align="left">Note</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- The source mode strings are lowercase.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ The source mode strings are lowercase.
+ </p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -573,18 +561,12 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt> is now deprecated. Blurbs,
- Admonitions
- and table cells (see Tables)
- may now contain paragraphs.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt> is now deprecated. Blurbs,
+ Admonitions
+ and table cells (see Tables)
+ may now contain paragraphs.
+ </p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -717,15 +699,9 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../../../doc/html/images/important.png"></td>
<th align="left">Important</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- Be careful when using the escape. The text must conform to BoostBook/DocBook syntax.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ Be careful when using the escape. The text must conform to BoostBook/DocBook syntax.
+ </p></td></tr>
</table></div>
</div>
<div class="section" lang="en">
@@ -748,19 +724,13 @@
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../../doc/html/images/warning.png"></td>
<th align="left">Warning</th>
</tr>
-<tr><td colspan="2" align="left" valign="top">
-<p>
- </p>
-<p>
- <tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt>
- and <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt> are now deprecated. Blurbs,
- Admonitions
- and table cells (see Tables)
- may now contain paragraphs.
- </p>
-<p>
- </p>
-</td></tr>
+<tr><td colspan="2" align="left" valign="top"><p>
+ <tt class="computeroutput"><span class="special">\</span><span class="identifier">n</span></tt>
+ and <tt class="computeroutput"><span class="special">[</span><span class="identifier">br</span><span class="special">]</span></tt> are now deprecated. Blurbs,
+ Admonitions
+ and table cells (see Tables)
+ may now contain paragraphs.
+ </p></td></tr>
</table></div>
<p>
The escaped space: <tt class="computeroutput"><span class="special">\</span> </tt> also
@@ -791,7 +761,7 @@
</pre>
<p>
will generate this
- <sup>[<a name="id457815" href="#ftn.id457815">2</a>]</sup>
+ <sup>[<a name="id457797" href="#ftn.id457797">2</a>]</sup>
.
</p>
<div class="section" lang="en">
@@ -844,7 +814,7 @@
</p>
<p>
Yes!
- <sup>[<a name="id457988" href="#ftn.id457988">3</a>]</sup>
+ <sup>[<a name="id457969" href="#ftn.id457969">3</a>]</sup>
</p>
</div>
<div class="footnotes">
@@ -856,10 +826,10 @@
being more or less a formal EBNF parser, can handle the context sensitivity
and ambiguity.
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id457815" href="#id457815">2</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id457797" href="#id457797">2</a>] </sup>
A sample footnote
</p></div>
-<div class="footnote"><p><sup>[<a name="ftn.id457988" href="#id457988">3</a>] </sup>
+<div class="footnote"><p><sup>[<a name="ftn.id457969" href="#id457969">3</a>] </sup>
Conditional Generation makes quickbook turing complete.
</p></div>
</div>
Modified: trunk/tools/quickbook/doc/quickbook.qbk
==============================================================================
--- trunk/tools/quickbook/doc/quickbook.qbk (original)
+++ trunk/tools/quickbook/doc/quickbook.qbk 2007-09-24 02:03:12 EDT (Mon, 24 Sep 2007)
@@ -1705,14 +1705,18 @@
Special comments of the form:
- /*<-- this will be ignored -->*/
+ /*<- this C++ comment will be ignored ->*/
or
- //<--
+ /*<-*/ "this c++ code will be ignored" /*->*/
+
+or
+
+ //<-
private:
int some_member;
- //-->
+ //->
can be used to inhibit code from passing through to quickbook. All text between
the delimeters will simply be ignored.
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