|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r53309 - in trunk/libs/spirit/repository/doc: . html html/spirit_repository karma
From: hartmut.kaiser_at_[hidden]
Date: 2009-05-27 13:13:59
Author: hkaiser
Date: 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
New Revision: 53309
URL: http://svn.boost.org/trac/boost/changeset/53309
Log:
Spirit: repository docs, added template
Added:
trunk/libs/spirit/repository/doc/repository_template.qbk (contents, props changed)
Text files modified:
trunk/libs/spirit/repository/doc/html/index.html | 4 ++--
trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components.html | 37 +++++++++++++++++++++++++++----------
trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html | 8 ++++----
trunk/libs/spirit/repository/doc/karma/confix.qbk | 1 +
4 files changed, 34 insertions(+), 16 deletions(-)
Modified: trunk/libs/spirit/repository/doc/html/index.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/index.html (original)
+++ trunk/libs/spirit/repository/doc/html/index.html 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
@@ -34,7 +34,7 @@
<div><p class="copyright">Copyright © 2001-2009 Joel
de Guzman, Hartmut Kaiser</p></div>
<div><div class="legalnotice" title="Legal Notice">
-<a name="id662785"></a><p>
+<a name="id632201"></a><p>
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)
</p>
@@ -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: May 27, 2009 at 02:06:39 GMT</small></p></td>
+<td align="left"><p><small>Last revised: May 27, 2009 at 17:08:45 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/karma_components.html 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
@@ -49,7 +49,7 @@
Confix Generator</a>
</h4></div></div></div>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.description"></a><h6>
-<a name="id663181"></a>
+<a name="id632597"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.description">Description</a>
</h6>
<p>
@@ -116,19 +116,19 @@
tag using a simple: <code class="computeroutput"><span class="identifier">ol</span><span class="special">[</span><span class="string">"Some text"</span><span class="special">]</span></code> (which results in <code class="computeroutput"><span class="special"><</span><span class="identifier">ol</span><span class="special">></span><span class="identifier">Some</span> <span class="identifier">text</span><span class="special"></</span><span class="identifier">ol</span><span class="special">></span></code>).
</p>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.header"></a><h6>
-<a name="id664105"></a>
+<a name="id633521"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.header">Header</a>
</h6>
<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">spirit</span><span class="special">/</span><span class="identifier">repository</span><span class="special">/</span><span class="identifier">include</span><span class="special">/</span><span class="identifier">karma_confix</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
</pre>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.synopsis"></a><h6>
-<a name="id664174"></a>
+<a name="id633591"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.synopsis">Synopsis</a>
</h6>
<pre class="programlisting"><span class="identifier">confix</span><span class="special">(</span><span class="identifier">prefix</span><span class="special">,</span> <span class="identifier">suffix</span><span class="special">)[</span><span class="identifier">subject</span><span class="special">]</span>
</pre>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.parameters"></a><h6>
-<a name="id664222"></a>
+<a name="id633639"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.parameters">Parameters</a>
</h6>
<div class="informaltable"><table class="table">
@@ -197,7 +197,7 @@
All three parameters can be arbitrary complex generators themselves.
</p>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.attribute"></a><h6>
-<a name="id667679"></a>
+<a name="id637095"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.attribute">Attribute</a>
</h6>
<p>
@@ -224,7 +224,7 @@
</p></td></tr>
</table></div>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.example"></a><h6>
-<a name="id667854"></a>
+<a name="id637270"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.example">Example</a>
</h6>
<p>
@@ -233,7 +233,7 @@
styles and a function prototype (for the full example code see here: confix.cpp)
</p>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.prerequisites"></a><h6>
-<a name="id667884"></a>
+<a name="id637300"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.prerequisites">Prerequisites</a>
</h6>
<p>
@@ -271,7 +271,7 @@
<p>
</p>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.generating_different_comment_styles"></a><h6>
-<a name="id668127"></a>
+<a name="id637544"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.generating_different_comment_styles">Generating
Different Comment Styles</a>
</h6>
@@ -302,11 +302,28 @@
comment proves to be straightforward:
</p>
<p>
+ </p>
+<p>
+
+</p>
+<pre class="programlisting"><span class="comment">// C comment
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span>
+ <span class="identifier">karma</span><span class="special">::</span><span class="identifier">format_delimited</span><span class="special">(</span>
+ <span class="identifier">confix</span><span class="special">(</span><span class="string">"/*"</span><span class="special">,</span> <span class="string">"*/"</span><span class="special">)[</span><span class="identifier">string</span><span class="special">],</span> <span class="comment">// format description
+</span> <span class="identifier">space</span><span class="special">,</span> <span class="comment">// delimiter
+</span> <span class="string">"This is a comment"</span> <span class="comment">// data
+</span> <span class="special">)</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span>
+</pre>
+<p>
+ </p>
+<p>
+ </p>
+<p>
which again will generate <code class="computeroutput"><span class="comment">/* This is a comment
*/</span> </code>.
</p>
<a name="spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.generating_a_function_prototype"></a><h6>
-<a name="id668298"></a>
+<a name="id637845"></a>
<a class="link" href="karma_components.html#spirit_repository.karma_components.karma_generator_primitives.karma_confix_generator.generating_a_function_prototype">Generating
a Function Prototype</a>
</h6>
@@ -337,7 +354,7 @@
<p>
</p>
<p>
- which generates the expected output: <code class="computeroutput"><span class="identifier">func</span><span class="special">(</span><span class="identifier">par1</span><span class="special">,</span> <span class="identifier">par2</span><span class="special">,</span> <span class="identifier">par3</span><span class="special">)</span></code>.
+ which generates the expected output: <code class="computeroutput"><span class="identifier">func</span><span class="special">(</span><span class="identifier">par1</span><span class="special">,</span><span class="identifier">par2</span><span class="special">,</span><span class="identifier">par3</span><span class="special">)</span></code>.
</p>
</div>
</div>
Modified: trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html
==============================================================================
--- trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html (original)
+++ trunk/libs/spirit/repository/doc/html/spirit_repository/preface.html 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
@@ -27,7 +27,7 @@
<a name="spirit_repository.preface"></a><a class="link" href="preface.html" title="Preface">Preface</a>
</h2></div></div></div>
<a name="spirit_repository.preface.the_spirit_repository"></a><h4>
-<a name="id662815"></a>
+<a name="id632231"></a>
<a class="link" href="preface.html#spirit_repository.preface.the_spirit_repository">The Spirit
Repository</a>
</h4>
@@ -40,7 +40,7 @@
General List</a>.
</p>
<a name="spirit_repository.preface.how_to_use_this_manual"></a><h4>
-<a name="id662850"></a>
+<a name="id632266"></a>
<a class="link" href="preface.html#spirit_repository.preface.how_to_use_this_manual">How to use
this manual</a>
</h4>
@@ -49,7 +49,7 @@
icons precede some text to indicate:
</p>
<div class="table">
-<a name="id662863"></a><p class="title"><b>Table 1. Icons</b></p>
+<a name="id632279"></a><p class="title"><b>Table 1. Icons</b></p>
<div class="table-contents"><table class="table" summary="Icons">
<colgroup>
<col>
@@ -170,7 +170,7 @@
Tools</a>.
</p>
<a name="spirit_repository.preface.support"></a><h4>
-<a name="id663104"></a>
+<a name="id632520"></a>
<a class="link" href="preface.html#spirit_repository.preface.support">Support</a>
</h4>
<p>
Modified: trunk/libs/spirit/repository/doc/karma/confix.qbk
==============================================================================
--- trunk/libs/spirit/repository/doc/karma/confix.qbk (original)
+++ trunk/libs/spirit/repository/doc/karma/confix.qbk 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
@@ -136,6 +136,7 @@
This code snippet will obviouly generate `// This is a comment \n `. Similarily
generating a 'C'-style comment proves to be straightforward:
+[karma_confix_c_comment]
which again will generate `/* This is a comment */ `.
Added: trunk/libs/spirit/repository/doc/repository_template.qbk
==============================================================================
--- (empty file)
+++ trunk/libs/spirit/repository/doc/repository_template.qbk 2009-05-27 13:13:58 EDT (Wed, 27 May 2009)
@@ -0,0 +1,38 @@
+[/==============================================================================
+ Copyright (C) <year> <name>
+
+ 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)
+===============================================================================/]
+
+[section <name of component>]
+
+[heading Description]
+
+[/ describe the component here]
+
+[heading Header]
+
+ #include <boost/spirit/repository/include/...>
+
+[heading Synopsis]
+
+[/ short usage synopsis]
+
+[heading Parameters]
+
+[table
+ [[Parameter] [Description]]
+ [[parameter in synopsis] [describe parameter]]
+]
+
+[heading Attribute]
+
+[/ describe the rules for attribute construction and propagation of your
+ component, use the same notation as used in the main Spirit docs]
+
+[heading Example]
+
+[/ describe some examples here, use uiqckbooks import feature to show the code]
+
+[endsect]
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