|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r67241 - in sandbox/configurator/libs/configurator/doc: . reference
From: for.dshevchenko_at_[hidden]
Date: 2010-12-15 09:54:00
Author: dshevchenko
Date: 2010-12-15 09:53:57 EST (Wed, 15 Dec 2010)
New Revision: 67241
URL: http://svn.boost.org/trac/boost/changeset/67241
Log:
Doc cleaning
Added:
sandbox/configurator/libs/configurator/doc/reference/
sandbox/configurator/libs/configurator/doc/reference/configurator.html (contents, props changed)
sandbox/configurator/libs/configurator/doc/reference/configurator_settings.html (contents, props changed)
sandbox/configurator/libs/configurator/doc/reference/option.html (contents, props changed)
sandbox/configurator/libs/configurator/doc/reference/single_configurator.html (contents, props changed)
Text files modified:
sandbox/configurator/libs/configurator/doc/index.html | 20 ++--
sandbox/configurator/libs/configurator/doc/overview.html | 38 +++-----
sandbox/configurator/libs/configurator/doc/own.css | 107 ++++++++++--------------
sandbox/configurator/libs/configurator/doc/reference.html | 172 +++++++++++++++++++++++++++++++++++++++
4 files changed, 236 insertions(+), 101 deletions(-)
Modified: sandbox/configurator/libs/configurator/doc/index.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/index.html (original)
+++ sandbox/configurator/libs/configurator/doc/index.html 2010-12-15 09:53:57 EST (Wed, 15 Dec 2010)
@@ -21,6 +21,8 @@
</table>
<hr/>
+
+ <div class="navigation">
</div>
<h1>Boost.Configurator</h1>
@@ -38,7 +40,6 @@
<div class="table_of_contents_first">
<a href="overview.html#motivation">Motivation</a><br/>
<a href="overview.html#hello">Hello, world!</a><br/>
- Features
</div>
<div class="table_of_contents_main">Requirements</div>
@@ -81,11 +82,7 @@
</div>
<div class="table_of_contents_main">Reference</div>
- <div class="table_of_contents_first">
- Header <boost/configurator/configurator.hpp><br/>
- Header <boost/configurator/option.hpp><br/>
- </div>
-
+
<div class="table_of_contents_main">Examples</div>
<div class="table_of_contents_first">
<a href="examples.html#hello_world">Hello, world!</a><br/>
@@ -105,9 +102,14 @@
<strong>Boost.Configurator</strong> is flexible and easy-to-use library for work with configuration files.
<br/><br/>
- <hr/>
- Last revised
+
+ <div class="last_revised">Last revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
- December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" -->
+ December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
+
+ <hr/>
+
+ <div class="navigation"></div>
+
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/overview.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/overview.html (original)
+++ sandbox/configurator/libs/configurator/doc/overview.html 2010-12-15 09:53:57 EST (Wed, 15 Dec 2010)
@@ -21,13 +21,16 @@
</table>
<hr/>
-
+
+ <div class="navigation">
+
+</div>
+
<h2>Overview</h2>
<dl class="index">
<dt>Motivation</dt>
<dt>Hello, world!</dt>
- <dt>Features</dt>
</dl>
<h3><a name="motivation"></a>Motivation</h3>
@@ -81,28 +84,15 @@
Value of host: 127.0.0.1
</pre>
<br/>
- <h3><a name="features"></a>Features</h3>
-
- <ul>
- <li>Header-only.</li>
- <li>Portable (there is only ISO C++ code and Boost C++ libraries).</li>
- <li>Type-based work with options, without string-identifiers.</li>
- <li>Option's necessity.</li>
- <li>Option's default value.</li>
- <li>Arbitrary nesting of sections.</li>
- <li>Checks of value's semantics, like correct path, valid IP, etc.</li>
- <li>Common checks of options and sections, like duplication, incorrection, etc.</li>
- <li>Single-line and multi-line comments (in C++ style).</li>
- <li>Options with multi-values.</li>
- <li>Singleton-variant of core class.</li>
- <li>Case (in)sensitivity for names of options and sections.</li>
- <li>Customizing configuration file format.</li>
- </ul>
-
- <br/>
- <hr/>
- Last revised
+
+ <div class="last_revised">Last revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
- December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" -->
+ December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
+
+ <hr/>
+
+ <div class="navigation">
+
+</div>
</body>
</html>
Modified: sandbox/configurator/libs/configurator/doc/own.css
==============================================================================
--- sandbox/configurator/libs/configurator/doc/own.css (original)
+++ sandbox/configurator/libs/configurator/doc/own.css 2010-12-15 09:53:57 EST (Wed, 15 Dec 2010)
@@ -1,6 +1,6 @@
body {
- padding: 0px 20px;
+ padding: 0px 10px;
}
div.table_of_contents {
@@ -27,6 +27,14 @@
padding-left: 60px;
}
+div.navigation {
+ text-align: right;
+}
+
+div.navigation a img {
+ border: 0;
+}
+
pre.cpp {
border: 1px solid gray;
background: #FFFAFA;
@@ -59,6 +67,39 @@
color: white;
}
+div.last_revised {
+ font-size: 70%;
+ font-family: Arial;
+}
+
+table.reference_table {
+ margin-left: 40px;
+ border: 1px;
+ background: #E8E8E8;
+ font-family: Arial;
+}
+
+table.reference_table a {
+ text-decoration: none;
+}
+
+table.reference_table a:hover {
+ text-decoration: underline;
+}
+
+table.reference_table td {
+ padding: 5px;
+}
+
+table.reference_table tr {
+ padding: 5px;
+}
+
+table.reference_table th {
+ padding: 5px;
+ background: #CFCFCF;
+}
+
h1.first_title {
margin-left: 50px;
}
@@ -78,68 +119,6 @@
h4 {
font-size: 108%;
+ margin-left: 20px;
}
-
-/*
-H1
-{
- FONT-SIZE: 200%;
- COLOR: #00008B;
-}
-H2
-{
- FONT-SIZE: 150%;
-}
-H3
-{
- FONT-SIZE: 125%;
-}
-H4
-{
- FONT-SIZE: 108%;
-}
-BODY
-{
- FONT-SIZE: 100%;
- BACKGROUND-COLOR: #ffffff;
- COLOR: #000000;
-}
-PRE
-{
- MARGIN-LEFT: 2em;
- FONT-FAMILY: Courier,
- monospace;
-}
-CODE
-{
- FONT-FAMILY: Courier,
- monospace;
-}
-CODE.as_pre
-{
- white-space: pre;
-}
-.index
-{
- TEXT-ALIGN: left;
-}
-.page-index
-{
- TEXT-ALIGN: left;
-}
-.definition
-{
- TEXT-ALIGN: left;
-}
-.footnote
-{
- FONT-SIZE: 66%;
- VERTICAL-ALIGN: super;
- TEXT-DECORATION: none;
-}
-.function-semantics
-{
- CLEAR: left;
-}
-*/
Modified: sandbox/configurator/libs/configurator/doc/reference.html
==============================================================================
--- sandbox/configurator/libs/configurator/doc/reference.html (original)
+++ sandbox/configurator/libs/configurator/doc/reference.html 2010-12-15 09:53:57 EST (Wed, 15 Dec 2010)
@@ -22,13 +22,177 @@
<hr/>
+ <div class="navigation">
+
+</div>
+
<h2>Reference</h2>
+
+ <dl class="index">
+ <dt>class configurator</dt>
+ <dt>class single_configurator</dt>
+ <dt>class configurator_settings</dt>
+ <dt>class option</dt>
+ <dt>conceptual macro</dt>
+ </dl>
+
+ <h3><a name="configurator">class configurator</a></h3>
+
+ This is core class of library.
+ <br/>
+ <h4>API functions<h4>
+
+ <table class="reference_table">
+ <tr align="left">
+ <th width="280"><strong>Name</strong></th>
+ <th width="550"><strong>Description</strong></th>
+ </tr>
+ <tr>
+ <td>configurator</td>
+ <td>Default constructor</td>
+ </tr>
+ <tr>
+ <td>add</td>
+ <td>Add option</td>
+ </tr>
+ <tr>
+ <td>get_value_of</td>
+ <td>Obtain value of option</td>
+ </tr>
+ <tr>
+ <td>load</td>
+ <td>Load options from configuration file</td>
+ </tr>
+ <tr>
+ <td>reload</td>
+ <td>Reload options from configuration file</td>
+ </tr>
+ <tr>
+ <td>settings</td>
+ <td>Provides access to the configurator_settings class</td>
+ </tr>
+ </table>
+
+ <br/>
+
+ <h3><a name="single_configurator">class single_configurator</a></h3>
+
+ This is Singleton-variant of configurator class.
+ <br/>
+ <h4>API functions<h4>
+
+ <table class="reference_table">
+ <tr align="left">
+ <th width="280"><strong>Name</strong></th>
+ <th width="550"><strong>Description</strong></th>
+ </tr>
+ <tr>
+ <td>inst</td>
+ <td>Access to single instance of configurator class</td>
+ </tr>
+ </table>
+
+ <br/>
+
+ <h3><a name="configurator_settings">class configurator_settings</a></h3>
+
+ This is class of Configurator settings.
+ <br/>
+ <h4>API functions<h4>
+ <table class="reference_table">
+ <tr align="left">
+ <th width="280"><strong>Name</strong></th>
+ <th width="550"><strong>Description</strong></th>
+ </tr>
+ <tr>
+ <td>set_case_sensitivity_for_names</td>
+ <td>Set case sensitivity for names of sections and options</td>
+ </tr>
+ <tr>
+ <td>send_warnings_to</td>
+ <td>Set std::ostream for sending possible warnings</td>
+ </tr>
+ <tr>
+ <td>set_name_value_separator</td>
+ <td>Set custom name-value separator for options, instead default '='</td>
+ </tr>
+ <tr>
+ <td>set_one_line_comment_sign</td>
+ <td>Set custom sign for one-line comments, instead default '//'</td>
+ </tr>
+ <tr>
+ <td>set_open_section_edging</td>
+ <td>Set custom edging for section opening</td>
+ </tr>
+ <tr>
+ <td>set_close_section_edging</td>
+ <td>Set custom edging for section closing</td>
+ </tr>
+ </table>
+
+ <br/>
+
+ <h3><a name="option">class option</a></h3>
+
+ This is class of one option. All factual options classes inherit from it.
+ <br/>
+ <h4>API functions<h4>
+
+ <table class="reference_table">
+ <tr align="left">
+ <th width="280"><strong>Name</strong></th>
+ <th width="550"><strong>Description</strong></th>
+ </tr>
+ <tr>
+ <td>set_location</td>
+ <td>Set location of this option in configuration file</td>
+ </tr>
+ <tr>
+ <td>set_default_value</td>
+ <td>Set default value for option</td>
+ </tr>
+ <tr>
+ <td>set_necessity</td>
+ <td>Set necessity of option</td>
+ </tr>
+ <tr>
+ <td>check_semantic</td>
+ <td>Set checking of some semantic</td>
+ </tr>
+ <tr>
+ <td>allow_multi_values</td>
+ <td>Allows existence of multi values for option</td>
+ </tr>
+ </table>
+
+ <br/>
+
+ <h3><a name="conceptual_macro">conceptual macro</a></h3>
- <br/><br/>
- <hr/>
- Last revised
+ This is macros for defining conceptual objects.
+ <br/><br/>
+ <table class="reference_table">
+ <tr align="left">
+ <th width="280"><strong>Name</strong></th>
+ <th width="550"><strong>Description</strong></th>
+ </tr>
+ <tr>
+ <td>BOOST_CONFIGURATOR_OPTION</td>
+ <td>Define conceptual option</td>
+ </tr>
+ </table>
+
+ <br/><br/>
+
+ <div class="last_revised">Last revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->10
- December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" -->
+ December, 2010<!--webbot bot="Timestamp" endspan i-checksum="38514" --></div>
+
+ <hr/>
+
+ <div class="navigation">
+
+</div>
</body>
</html>
Added: sandbox/configurator/libs/configurator/doc/reference/configurator.html
==============================================================================
Added: sandbox/configurator/libs/configurator/doc/reference/configurator_settings.html
==============================================================================
Added: sandbox/configurator/libs/configurator/doc/reference/option.html
==============================================================================
Added: sandbox/configurator/libs/configurator/doc/reference/single_configurator.html
==============================================================================
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