Boost-Commit :

Date view	Thread view	Subject view	Author view

From: hartmut.kaiser_at_[hidden]
Date: 2007-12-02 20:16:28

Author: hkaiser
Date: 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
New Revision: 41621
URL: http://svn.boost.org/trac/boost/changeset/41621

Log:
Wave: Updated documentation.
Text files modified:
   trunk/libs/wave/doc/class_reference_context.html | 28 ++++++++++++++--------------
   trunk/libs/wave/doc/class_reference_ctxpolicy.html | 6 +++---
   trunk/libs/wave/doc/introduction.html | 4 ++--
   trunk/libs/wave/doc/preface.html | 11 +++++------
   trunk/libs/wave/doc/quickstart.html | 8 ++++----
   trunk/libs/wave/index.html | 4 ++--
   6 files changed, 30 insertions(+), 31 deletions(-)

Modified: trunk/libs/wave/doc/class_reference_context.html
==============================================================================
--- trunk/libs/wave/doc/class_reference_context.html (original)
+++ trunk/libs/wave/doc/class_reference_context.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -52,7 +52,7 @@

 template <
 typename Iterator, typename LexIterator,
- typename InputPolicy, typename TracePolicy
+ typename InputPolicy, typename ContextPolicy
 >
 class context : public InputPolicy
 {
@@ -66,7 +66,7 @@
 <a href="class_reference_context.html#constructor">context</a>(Iterator const &first_,
 Iterator const &last_,
 char const *fname = "<Unknown>",
- TracePolicy const& trace = TracePolicy())
+ ContextPolicy const& ctx_policy = ContextPolicy())

 // iterator interface
 iterator_type begin() const;
@@ -135,9 +135,9 @@
 to use, when it comes to including and opening an included file.</td>
 </tr>
 <tr>
- <td class="table_cells"><code>TracePolicy</code></td>
- <td class="table_cells">The type of the trace policy class, which allows
- to customize the trace output generated while expanding macros. The requirements for this policy are described here.</td>
+ <td class="table_cells"><code>ContextPolicy</code></td>
+ <td class="table_cells">The type of the context policy class, which allows
+ to customize different aspects of the behaviour of the preprocessing. The requirements of this policy and the available customization points provided by this policy are described here.</td>
 </tr>
</table>
For further information about the lexer type to use, please refer to the <a href="class_reference_lexer.html">The
@@ -145,9 +145,9 @@
If the template parameter <tt>InputPolicy</tt> is omitted, the template <tt>boost::wave::iteration_context_policies::load_file_to_string</tt>
 is used. For further information about the input policy, please refer to the
 topic The Input Policy.
-If the template parameter TracePolicyT is omitted, the <tt>boost::wave::macro_trace_policies::no_tracing</tt>
- policy type is used, i.e. by default there is no tracing performed. For further
- information about the hooking policy, please refer to the topic <a href="class_reference_ctxpolicy.html">The
+If the template parameter ContextPolicy is omitted, the <tt>boost::wave::context_policies::eat_whitespace</tt>
+ policy type is used, implementing certain basic preprocessing hooks needed for normal (default) execution. For further
+ information about the context policy, please refer to the topic <a href="class_reference_ctxpolicy.html">The
 Context Policy</a>. 
<h2><a name="public_typedefs"></a>Public Typedefs</h2>
The <tt>boost::wave::context</tt> template defines the following public typedefs, which may be useful while using this class:
@@ -172,8 +172,8 @@
 <td class="table_cells">The <tt>InputPolicy</tt> template parameter provided, while the <tt>context</tt> class was instantiated. </td>
 </tr>
 <tr>
- <td class="table_cells"><code>trace_policy_type</code></td>
- <td class="table_cells">The <tt>TracePolicy</tt> template parameter provided, while the <tt>context</tt> class was instantiated. </td>
+ <td class="table_cells"><code>context_policy_type</code></td>
+ <td class="table_cells">The <tt>ContextPolicy</tt> template parameter provided, while the <tt>context</tt> class was instantiated. </td>
 </tr>
 <tr>
 <td class="table_cells"><code>position_type</code></td>
@@ -184,15 +184,15 @@
<a name="constructor" id="constructor"></a>Constructor
<pre> context(Iterator const &first,
 Iterator const &last, char const *filename,
- TracePolicy const& trace);</pre>
+ ContextPolicy const& ctx_policy);</pre>
 Constructs a context object on top of the input stream given by the pair
 of auxilliary iterators <tt>[first, last)</tt>. The iterators should
 be at least <tt>forward_iterator</tt> type iterators. The filename parameter
 is to be supplied for informational purposes only. This string is used for
 indicating the token positions inside the input stream, it is not validated
 against the file system. If the filename parameter is not given it defaults
- to "<Unknown>". If the trace
- parameter isn't supplied it defaults to a default constructed <tt>TracePolicy</tt>
+ to "<Unknown>". If the ctx_policy
+ parameter isn't supplied it defaults to a default constructed <tt>ContextPolicy</tt>
 object. 
 Additionally the macro symbol table is filled with the predefined macros
 and the current reference directory is set to the path of the given filename.
@@ -507,7 +507,7 @@
 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) 

Last updated:
- Tuesday, June 26, 2007 20:21
+ Sunday, December 2, 2007 19:12

Modified: trunk/libs/wave/doc/class_reference_ctxpolicy.html
==============================================================================
--- trunk/libs/wave/doc/class_reference_ctxpolicy.html (original)
+++ trunk/libs/wave/doc/class_reference_ctxpolicy.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -38,10 +38,10 @@
 <li>a token is about to be returned from the preprocessor, </li>
 <li>a macro get's defined or undefined, </li>
 <li>a macro has been expanded or rescanned,</li>
- <li>an include file has been opened or left, </li>
+ <li>an include file has been opened or closed, </li>
 <li>a conditional expression was evaluated,</li>
 <li>a token has to be skipped because it is contained in a non-evaluated conditional block, </li>
- <li> a pragma of the form <tt>'wave option[(value)]'</tt> has been recognised. </li>
+ <li> a pragma of the form <tt>'wave option[(value)]'</tt> has been recognized. </li>
</ul>
This policy type is used as a template parameter to the boost::wave::context<>
 object, where the default policy provides empty hook functions only.
@@ -435,7 +435,7 @@
 
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) 
Last updated:
- Wednesday, July 4, 2007 16:10
+ Sunday, December 2, 2007 19:12

</body>
</html>

Modified: trunk/libs/wave/doc/introduction.html
==============================================================================
--- trunk/libs/wave/doc/introduction.html (original)
+++ trunk/libs/wave/doc/introduction.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -32,7 +32,7 @@
 iterator interface. The context object helps to configure the actual preprocessing
 process (as search path's, predefined macros, etc.). The exposed iterators are
 generated by this context object too. Iterating over the sequence defined by
- the two iterators will return the preprocessed tokens, which are to be built
+ the two iterators will return the preprocessed tokens, which are built
 on the fly from the given input stream. 
 The C++ preprocessor iterator itself is fed by a C++ lexer iterator,
 which implements an abstract interface. The C++ lexers packaged with the
@@ -87,7 +87,7 @@
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) 

Last updated:
- Wednesday, December 14, 2005 10:58
+ Sunday, December 2, 2007 19:03
 
</body>
</html>

Modified: trunk/libs/wave/doc/preface.html
==============================================================================
--- trunk/libs/wave/doc/preface.html (original)
+++ trunk/libs/wave/doc/preface.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -23,7 +23,7 @@
 <td width="30"></td>
 </tr>
</table>
-During the last time many new features were developed as additions to the <tt>Spirit</tt>
+During the last time many new features have been developed as additions to the <tt>Spirit</tt>
 <a href="references.html#spirit">[4]</a> parser construction framework and we
 felt more and more, that it would be very helpful, to have a 'real world' example,
 which could be used as a sandbox for testing the usability of certain features.
@@ -41,7 +41,7 @@
 The C++ preprocessor is a macro processor that under normal
 circumstances is used automatically by your C++ compiler to transform your program
 before actual compilation. It is called a macro processor because it allows
- you to define macros, which are brief abbreviations for longer constructs. The
+ to define macros, which are brief abbreviations for longer constructs. The
 C++ preprocessor provides four separate facilities that you can use as you see
 fit: 
<blockquote>
@@ -61,7 +61,7 @@
 generative metaprogramming combined with template metaprogramming in C++ is
 by far one of the most powerful compile-time reflection/metaprogramming facilities
 that any language has ever supported.
-The C++ Standard [2] was adopted back in 1998, but there is still no (known to me) C++ compiler, which has a bugfree implementation of the rather simple preprocessor requirements mandated therein. This may be a result of the mentioned underestimation or even banning of the preprocessor from good programming style during the last few years or may stem from the somewhat awkward standardese dialect of English used to describe it. 
+The C++ Standard [2] was adopted back in 1998, but there is still no (known to me) commercial C++ compiler, which has a bugfree implementation of the rather simple preprocessor requirements mandated therein. This may be a result of the mentioned underestimation or even banning of the preprocessor from good programming style during the last few years or may stem from the somewhat awkward standardese dialect of English used to describe it. Two open source projects are exceptions of this: gcc and Clang (a subproject of LLVM), both providing preprocessors with very good standards conformance. 
So the main goals for the <tt>Wave</tt> project are:
<blockquote>
 <img src="theme/bullet.gif" width="13" height="13" id="IMG1"> full
@@ -88,8 +88,7 @@
preprocessors when complexity increases.
As tests showed, the <tt>Wave</tt> library is very conformant to the C++ Standard,
 such that it compiles several strict conformant macro definitions, which are
- not even compilable with EDG based preprocessors (i.e. Comeau or Intel). The only preprocessor known to have similar Standards conformance
-today is the preprocessor of the gcc C/C++ compiler.
+not even compilable with EDG based preprocessors (i.e. Comeau or Intel). 
<table border="0">
 <tr>
 <td width="10"></td>
@@ -104,7 +103,7 @@
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) 

Last updated:
- Sunday, May 15, 2005 12:23
+ Sunday, December 2, 2007 19:03

</body>
</html>

Modified: trunk/libs/wave/doc/quickstart.html
==============================================================================
--- trunk/libs/wave/doc/quickstart.html (original)
+++ trunk/libs/wave/doc/quickstart.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -24,7 +24,7 @@
 <td width="30"></td>
 </tr>
</table>
-Preprocessing with Wave is highly configurable. You must
+Preprocessing with <tt>Wave</tt> is highly configurable. You must
define a few options to control it. Here are a few of the
options you can define:
<BLOCKQUOTE dir="ltr" style="MARGIN-RIGHT: 0px">
@@ -38,13 +38,13 @@
 
</BLOCKQUOTE>
You can access all these processing parameters through the <tt>boost::wave::context</tt>
- object. So you must instantiate one object of this type to use the <tt>Wave</tt>
+ object. So you must instantiate one object instance of this type to use the <tt>Wave</tt>
 library. (For more information about the context template class, please refer
 to the class reference here.) To instantiate
 the <tt>boost::wave::context</tt> object you have to supply at least two template parameters:
 the iterator type of the underlying input stream to use and the type of the lexer iterator to be used as the token source for the preprocessing engine.
Do not instantiate the main preprocessing iterators yourself.
-Get them from the wave::context object instead.
+Get them from the <tt>boost::wave::context</tt> object instead.
The following code snippet is taken from the <tt>quick_start</tt> sample, which shows a minimal usage scenario for <tt>Wave</tt>. 
<pre> // The following preprocesses a given input file.
 // Open the file and read it into a string variable
@@ -115,7 +115,7 @@
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) 

Last updated:
- Wednesday, July 26, 2006 19:28
+ Sunday, December 2, 2007 19:06

</body>
</html>

Modified: trunk/libs/wave/index.html
==============================================================================
--- trunk/libs/wave/index.html (original)
+++ trunk/libs/wave/index.html 2007-12-02 20:16:28 EST (Sun, 02 Dec 2007)
@@ -10,7 +10,7 @@
 <tr>
 <td width="21"> <h1></h1></td>
 <td width="885"> Wave
- V1.2.4</td>
+ V1.3</td>
 <td width="96"></td>
 </tr>
</table>
@@ -104,7 +104,7 @@
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) 

Last updated:
- Tuesday, May 23, 2006 12:37
+ Sunday, December 2, 2007 18:57

</body>
</html>

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