boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2024-12-26 23:30:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merged L & C issue fixes & HTML conversions from trunk to branch.

Browse Source 
[SVN r36262]
This commit is contained in:
Andreas Huber 2006-12-04 13:24:23 +00:00
parent f82cba6fb5
commit 26e20ccb9a
17 changed files with 2928 additions and 2483 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

380
borland_cpp.html
View File

@ -1,103 +1,111 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<title>Portability Hints: Borland C++ 5.5.1</title> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Portability Hints: Borland C++ 5.5.1</title>
</head> </head>
<body bgcolor="#FFFFFF" text="#000000"> <body bgcolor="#FFFFFF" text="#000000">
<table border="1" bgcolor="#007F7F" cellpadding="2" summary="">
<tr>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt=
"boost.png (6897 bytes)" width="277" height="86"></td>
<table border="1" bgcolor="#007F7F" cellpadding="2"> <td><a href="../index.htm"><font face="Arial,Helvetica" color=
<tr> "#FFFFFF"><big>Home</big></font></a></td>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td>
<td><a href="../index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Home</big></font></a></td>
<td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Libraries</big></font></a></td>
<td><a href="../people/people.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>People</big></font></a></td>
<td><a href="faq.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>FAQ</big></font></a></td>
<td><a href="index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>More</big></font></a></td>
</tr>
</table>
<p> <td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color=
"#FFFFFF"><big>Libraries</big></font></a></td>
<h1>Portability Hints: Borland C++ 5.5.1</h1> <td><a href="../people/people.htm"><font face="Arial,Helvetica" color=
"#FFFFFF"><big>People</big></font></a></td>
It is a general aim for boost libraries to be <td><a href="faq.htm"><font face="Arial,Helvetica" color=
<a href="lib_guide.htm#Portability">portable</a>. The primary means "#FFFFFF"><big>FAQ</big></font></a></td>
for achieving this goal is to adhere to ISO Standard C++. However,
ISO C++ is a broad and complex standard and most compilers are
not fully conformant to ISO C++ yet. In order to achieve portability
in the light of this restriction, it seems advisable to get acquainted
with those language features that some compilers do not fully
implement yet.
<p>
This page gives portability hints on some language features of the <td><a href="index.htm"><font face="Arial,Helvetica" color=
Borland C++ version 5.5.1 compiler. Furthermore, the appendix "#FFFFFF"><big>More</big></font></a></td>
presents additional problems with Borland C++ version 5.5. Borland </tr>
C++ 5.5.1 is a freely available command-line compiler for Win32 </table>
available at
<a href="http://www.borland.com/">http://www.borland.com/</a>.
<p>
Each entry in the following list describes a particular issue, <h1>Portability Hints: Borland C++ 5.5.1</h1>
complete with sample source code to demonstrate the effect.
Most sample code herein has been verified to compile with gcc 2.95.2
and Comeau C++ 4.2.44.
<p>It is a general aim for boost libraries to be <a href=
"lib_guide.htm#Portability">portable</a>. The primary means for achieving
this goal is to adhere to ISO Standard C++. However, ISO C++ is a broad and
complex standard and most compilers are not fully conformant to ISO C++
yet. In order to achieve portability in the light of this restriction, it
seems advisable to get acquainted with those language features that some
compilers do not fully implement yet.</p>
<h2>Preprocessor symbol</h2> <p>This page gives portability hints on some language features of the
Borland C++ version 5.5.1 compiler. Furthermore, the appendix presents
additional problems with Borland C++ version 5.5. Borland C++ 5.5.1 is a
freely available command-line compiler for Win32 available at <a href=
"http://www.borland.com/">http://www.borland.com/</a>.</p>
The preprocessor symbol <code>__BORLANDC__</code> is defined for all <p>Each entry in the following list describes a particular issue, complete
Borland C++ compilers. Its value is the version number of the with sample source code to demonstrate the effect. Most sample code herein
compiler interpreted as a hexadecimal number. The following table has been verified to compile with gcc 2.95.2 and Comeau C++ 4.2.44.</p>
lists some known values.
<p>
<table border="1"> <h2>Preprocessor symbol</h2>
<tr>
<th>Compiler</th>
<th><code>__BORLANDC__</code> value</th>
</tr>
<tr> <p>The preprocessor symbol <code>__BORLANDC__</code> is defined for all
<td>Borland C++ Builder 4</td> Borland C++ compilers. Its value is the version number of the compiler
<td>0x0540</td> interpreted as a hexadecimal number. The following table lists some known
</tr> values.</p>
<tr> <table border="1" summary="">
<td>Borland C++ Builder 5</td> <tr>
<td>0x0550</td> <th>Compiler</th>
</tr>
<tr> <th><code>__BORLANDC__</code> value</th>
<td>Borland C++ 5.5</td> </tr>
<td>0x0550</td>
</tr>
<tr> <tr>
<td>Borland C++ 5.5.1</td> <td>Borland C++ Builder 4</td>
<td>0x0551</td>
</tr>
<tr> <td>0x0540</td>
<td>Borland C++ Builder 6</td> </tr>
<td>0x0560</td>
</tr>
</table> <tr>
<td>Borland C++ Builder 5</td>
<h2>Core Language</h2> <td>0x0550</td>
</tr>
<h3>[using-directive] Mixing <code>using</code>-declarations and <tr>
<code>using</code>-directives</h3> <td>Borland C++ 5.5</td>
Mixing <code>using</code>-directives (which refer to whole namespaces) <td>0x0550</td>
and namespace-level <code>using</code>-declarations (which refer to </tr>
individual identifiers within foreign namespaces) causes ambiguities
where there are none. The following code fragment illustrates this:
<pre> <tr>
<td>Borland C++ 5.5.1</td>
<td>0x0551</td>
</tr>
<tr>
<td>Borland C++ Builder 6</td>
<td>0x0560</td>
</tr>
</table>
<h2>Core Language</h2>
<h3>[using-directive] Mixing <code>using</code>-declarations and
<code>using</code>-directives</h3>
<p>Mixing <code>using</code>-directives (which refer to whole namespaces)
and namespace-level <code>using</code>-declarations (which refer to
individual identifiers within foreign namespaces) causes ambiguities where
there are none. The following code fragment illustrates this:</p>
<pre>
namespace N { namespace N {
int x(); int x();
} }
@ -111,15 +119,13 @@ int main()
} }
</pre> </pre>
<h3>[using template] <code>using</code>-declarations for class
templates</h3>
<h3>[using template] <code>using</code>-declarations for class <p>Identifiers for class templates can be used as arguments to
templates</h3> <code>using</code>-declarations as any other identifier. However, the
following code fails to compile with Borland C++:</p>
Identifiers for class templates can be used as arguments to <pre>
<code>using</code>-declarations as any other identifier. However, the
following code fails to compile with Borland C++:
<pre>
template&lt;class T&gt; template&lt;class T&gt;
class X { }; class X { };
@ -130,14 +136,12 @@ namespace N
}; };
</pre> </pre>
<h3>[template const arg] Deduction of constant arguments to function
templates</h3>
<h3>[template const arg] Deduction of constant arguments to function <p>Template function type deduction should omit top-level constness.
templates</h3> However, this code fragment instantiates "f&lt;const int&gt;(int)":</p>
<pre>
Template function type deduction should omit top-level constness.
However, this code fragment instantiates "f&lt;const int&gt;(int)":
<pre>
template&lt;class T&gt; template&lt;class T&gt;
void f(T x) void f(T x)
{ {
@ -155,16 +159,11 @@ int main()
} }
</pre> </pre>
The boost/rational.hpp header exhibits this problem in connection with <h3>[function address] Resolving addresses of overloaded functions</h3>
the gcd() function.
<p>Addresses of overloaded functions are not in all contexts properly
<h3>[function address] Resolving addresses of overloaded resolved (std:13.4 [over.over]); here is a small example:</p>
functions</h3> <pre>
Addresses of overloaded functions are not in all contexts properly
resolved (std:13.4 [over.over]); here is a small example:
<pre>
template&lt;class Arg&gt; template&lt;class Arg&gt;
void f( void(*g)(Arg) ); void f( void(*g)(Arg) );
@ -191,17 +190,16 @@ int main()
} }
</pre> </pre>
<strong>Workaround:</strong> Always use C-style casts when determining <p><strong>Workaround:</strong> Always use C-style casts when determining
addresses of (potentially) overloaded functions. addresses of (potentially) overloaded functions.</p>
<h3>[string conversion] Converting <code>const char *</code> to <h3>[string conversion] Converting <code>const char *</code> to
<code>std::string</code></h3> <code>std::string</code></h3>
Implicitly converting <code>const char *</code> parameters to <p>Implicitly converting <code>const char *</code> parameters to
<code>std::string</code> arguments fails if template functions are <code>std::string</code> arguments fails if template functions are
explicitly instantiated (it works in the usual cases, though): explicitly instantiated (it works in the usual cases, though):</p>
<pre>
<pre>
#include &lt;string&gt; #include &lt;string&gt;
template&lt;class T&gt; template&lt;class T&gt;
@ -215,22 +213,19 @@ int main()
</pre> </pre>
<strong>Workaround:</strong> Avoid explicit template function <p><strong>Workaround:</strong> Avoid explicit template function
instantiations (they have significant problems with Microsoft Visual instantiations (they have significant problems with Microsoft Visual C++)
C++) and pass default-constructed unused dummy arguments with the and pass default-constructed unused dummy arguments with the appropriate
appropriate type. Alternatively, if you wish to keep to the explicit type. Alternatively, if you wish to keep to the explicit instantiation, you
instantiation, you could use an explicit conversion to could use an explicit conversion to <code>std::string</code> or declare the
<code>std::string</code> or declare the template function as taking a template function as taking a <code>const char *</code> parameter.</p>
<code>const char *</code> parameter.
<h3>[template value defaults] Dependent default arguments for template
value parameters</h3>
<h3>[template value defaults] Dependent default arguments for template <p>Template value parameters which default to an expression dependent on
value parameters</h3> previous template parameters don't work:</p>
<pre>
Template value parameters which default to an expression dependent on
previous template parameters don't work:
<pre>
template&lt;class T&gt; template&lt;class T&gt;
struct A struct A
{ {
@ -248,33 +243,29 @@ int main()
</pre> </pre>
<p><strong>Workaround:</strong> If the relevant non-type template parameter
is an implementation detail, use inheritance and a fully qualified
identifier (for example, ::N::A&lt;T&gt;::value).</p>
<strong>Workaround:</strong> If the relevant non-type template <h3>[function partial ordering] Partial ordering of function templates</h3>
parameter is an implementation detail, use inheritance and a fully
qualified identifier (for example, ::N::A&lt;T&gt;::value).
<p>Partial ordering of function templates, as described in std:14.5.5.2
<h3>[function partial ordering] Partial ordering of function [temp.func.order], does not work:</p>
templates</h3> <pre>
Partial ordering of function templates, as described in std:14.5.5.2
[temp.func.order], does not work:
<pre>
#include &lt;iostream&gt; #include &lt;iostream&gt;
template&lt;class T&gt; struct A {}; template&lt;class T&gt; struct A {};
template&lt;class T1&gt; template&lt;class T1&gt;
void f(const A&lt;T1&gt; &) void f(const A&lt;T1&gt; &amp;)
{ {
std::cout << "f(const A&lt;T1&gt;&)\n"; std::cout &lt;&lt; "f(const A&lt;T1&gt;&amp;)\n";
} }
template&lt;class T&gt; template&lt;class T&gt;
void f(T) void f(T)
{ {
std::cout << "f(T)\n"; std::cout &lt;&lt; "f(T)\n";
} }
int main() int main()
@ -285,16 +276,16 @@ int main()
} }
</pre> </pre>
<strong>Workaround:</strong> Declare all such functions uniformly as <p><strong>Workaround:</strong> Declare all such functions uniformly as
either taking a value or a reference parameter. either taking a value or a reference parameter.</p>
<h3>[instantiate memfun ptr] Instantiation with member function
pointer</h3>
<h3>[instantiate memfun ptr] Instantiation with member function pointer</h3> <p>When directly instantiating a template with some member function
pointer, which is itself dependent on some template parameter, the compiler
When directly instantiating a template with some member function cannot cope:</p>
pointer, which is itself dependent on some template parameter, the <pre>
compiler cannot cope:
<pre>
template&lt;class U&gt; class C { }; template&lt;class U&gt; class C { };
template&lt;class T&gt; template&lt;class T&gt;
class A class A
@ -303,9 +294,9 @@ class A
}; };
</pre> </pre>
<strong>Workaround:</strong> Use an intermediate <code>typedef</code>: <p><strong>Workaround:</strong> Use an intermediate
<code>typedef</code>:</p>
<pre> <pre>
template&lt;class U&gt; class C { }; template&lt;class U&gt; class C { };
template&lt;class T&gt; template&lt;class T&gt;
class A class A
@ -315,20 +306,16 @@ class A
}; };
</pre> </pre>
(Extracted from e-mail exchange of David Abrahams, Fernando Cacciola, <p>(Extracted from e-mail exchange of David Abrahams, Fernando Cacciola,
and Peter Dimov; not actually tested.) and Peter Dimov; not actually tested.)</p>
<h2>Library</h2>
<h2>Library</h2> <h3>[cmath.abs] Function <code>double std::abs(double)</code> missing</h3>
<p>The function <code>double std::abs(double)</code> should be defined
<h3>[cmath.abs] Function <code>double std::abs(double)</code> (std:26.5-5 [lib.c.math]), but it is not:</p>
missing</h3> <pre>
The function <code>double std::abs(double)</code> should be defined
(std:26.5-5 [lib.c.math]), but it is not:
<pre>
#include &lt;cmath&gt; #include &lt;cmath&gt;
int main() int main()
@ -337,40 +324,39 @@ int main()
} }
</pre> </pre>
Note that <code>int std::abs(int)</code> will be used without warning <p>Note that <code>int std::abs(int)</code> will be used without warning if
if you write <code>std::abs(5.1)</code>. you write <code>std::abs(5.1)</code>.</p>
<p>
Similar remarks apply to seemingly all of the other standard math
functions, where Borland C++ fails to provide <code>float</code> and
<code>long double</code> overloads.
<p>
<strong>Workaround:</strong> Use <code>std::fabs</code> instead if
type genericity is not required.
<h2>Appendix: Additional issues with Borland C++ version 5.5</h2> <p>Similar remarks apply to seemingly all of the other standard math
functions, where Borland C++ fails to provide <code>float</code> and
<code>long double</code> overloads.</p>
These issues are documented mainly for historic reasons. If you are <p><strong>Workaround:</strong> Use <code>std::fabs</code> instead if type
still using Borland C++ version 5.5, you are strongly encouraged to genericity is not required.</p>
obtain an upgrade to version 5.5.1, which fixes the issues described
in this section.
<h3>[inline friend] Inline friend functions in template classes</h3> <h2>Appendix: Additional issues with Borland C++ version 5.5</h2>
If a friend function of some class has not been declared before the <p>These issues are documented mainly for historic reasons. If you are
friend function declaration, the function is declared at the namespace still using Borland C++ version 5.5, you are strongly encouraged to obtain
scope surrounding the class definition. Together with class templates an upgrade to version 5.5.1, which fixes the issues described in this
and inline definitions of friend functions, the code in the following section.</p>
fragment should declare (and define) a non-template function "bool
N::f(int,int)", which is a friend of class N::A&lt;int&gt;. However,
Borland C++ v5.5 expects the function f to be declared beforehand:
<pre> <h3>[inline friend] Inline friend functions in template classes</h3>
<p>If a friend function of some class has not been declared before the
friend function declaration, the function is declared at the namespace
scope surrounding the class definition. Together with class templates and
inline definitions of friend functions, the code in the following fragment
should declare (and define) a non-template function "bool N::f(int,int)",
which is a friend of class N::A&lt;int&gt;. However, Borland C++ v5.5
expects the function f to be declared beforehand:</p>
<pre>
namespace N { namespace N {
template&lt;class T&gt; template&lt;class T&gt;
class A class A
{ {
// "f is not a member of 'N' in function main()" // "f is not a member of 'N' in function main()"
friend bool f(T x, T y) { return x < y; } friend bool f(T x, T y) { return x &lt; y; }
}; };
} }
@ -380,19 +366,29 @@ int main()
} }
</pre> </pre>
This technique is extensively used in boost/operators.hpp. Giving in <p>This technique is extensively used in boost/operators.hpp. Giving in to
to the wish of the compiler doesn't work in this case, because then the wish of the compiler doesn't work in this case, because then the
the "instantiate one template, get lots of helper functions at "instantiate one template, get lots of helper functions at namespace scope"
namespace scope" approach doesn't work anymore. Defining approach doesn't work anymore. Defining BOOST_NO_OPERATORS_IN_NAMESPACE (a
BOOST_NO_OPERATORS_IN_NAMESPACE (a define define BOOST_NO_INLINE_FRIENDS_IN_CLASS_TEMPLATES would match this case
BOOST_NO_INLINE_FRIENDS_IN_CLASS_TEMPLATES would match this case better) works around this problem and leads to another one, see
better) works around this problem and leads to another one, see [using-template].</p>
[using-template]. <hr>
<p> <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<hr> <p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->03
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38512" --></p>
2000-09-30 <a href="../people/jens_maurer.htm">Jens Maurer</a> <p><i>Copyright &copy; 2000-2002 <a href="../people/jens_maurer.htm">Jens
Maurer</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

1406
count_bdy.htm
View File

File diff suppressed because it is too large Load Diff

41
discussion_policy.htm
View File

@ -2,17 +2,17 @@
<html> <html>
<head> <head>
<meta name="generator" content= <meta http-equiv="Content-Language" content="en-us">
"HTML Tidy for Cygwin (vers 1st September 2004), see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="GENERATOR" content="Microsoft FrontPage 5.0">
<meta name="generator" content="Microsoft FrontPage 6.0">
<meta name="ProgId" content="FrontPage.Editor.Document"> <meta name="ProgId" content="FrontPage.Editor.Document">
<title>Boost Discussion Policy</title> <title>Boost Discussion Policy</title>
</head> </head>
<body bgcolor="#FFFFFF" text="#000000"> <body bgcolor="#FFFFFF" text="#000000">
<table border="1" bgcolor="#007F7F" cellpadding="2"> <table border="1" bgcolor="#007F7F" cellpadding="2" summary="">
<tr> <tr>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt= <td bgcolor="#FFFFFF"><img src="../boost.png" alt=
"boost.png (6897 bytes)" width="277" height="86"></td> "boost.png (6897 bytes)" width="277" height="86"></td>
@ -153,7 +153,6 @@
<blockquote> <blockquote>
<pre> <pre>
<i>Person-you're-replying-to</i> wrote: <i>Person-you're-replying-to</i> wrote:
&gt; Some part of a paragraph that you wish to reply to goes &gt; Some part of a paragraph that you wish to reply to goes
@ -309,15 +308,16 @@ Your response to the second part of the message goes here.
far."</li> far."</li>
</ul> </ul>
<p>Avoid Parkinson's Bicycle Shed. Parkinson described a committee formed <p>Avoid <i><b>Parkinson's Bicycle Shed</b></i>. Parkinson described a
to oversee design of an early nuclear power plant. There were three agenda committee formed to oversee design of an early nuclear power plant. There
items - when to have tea, where to put the bicycle shed, and how to ensure were three agenda items - when to have tea, where to put the bicycle shed,
nuclear safety. Tea was disposed of quickly as trivial.&nbsp;&nbsp; Nuclear and how to ensure nuclear safety. Tea was disposed of quickly as
safety was discussed for only an hour - it was so complex, scary, and trivial.&nbsp;Nuclear safety was discussed for only an hour - it was so
technical that even among experts few felt comfortable with the issues. complex, scary, and technical that even among experts few felt comfortable
Endless days were then spent discussing where to put the bicycle shed (the with the issues. Endless days were then spent discussing construction of
parking lot would be a modern equivalent) because everyone understood the the bicycle shed (the parking lot would be the modern equivalent) because
issues and felt comfortable discussing them.&nbsp;</p> everyone though they understood the issues and felt comfortable discussing
them.&nbsp;</p>
<h2><a name="lib_names" id="lib_names"></a>Library Names</h2> <h2><a name="lib_names" id="lib_names"></a>Library Names</h2>
@ -353,15 +353,18 @@ Your response to the second part of the message goes here.
potential Boost libraries.</p> potential Boost libraries.</p>
<hr> <hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised <p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->28 <!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->04 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
May, 2005<!--webbot bot="Timestamp" i-checksum="38549" endspan --></p>
<p>&copy; Beman Dawes, Rob Stewart, and David Abrahams 2000-2005</p> <p><i>Copyright &copy; 2000-2005 Beman Dawes, Rob Stewart, and David Abrahams</i></p>
<p>Distributed under the Boost Software License, Version 1.0. (See <p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href= at <a href=
"http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</p> "http://www.boost.org/LICENSE_1_0.txt">www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

349
microsoft_vcpp.html
View File

@ -1,79 +1,85 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<title>Portability Hints: Microsoft Visual C++ 6.0 SP4</title> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Portability Hints: Microsoft Visual C++ 6.0 SP4</title>
</head> </head>
<body bgcolor="#FFFFFF" text="#000000"> <body bgcolor="#FFFFFF" text="#000000">
<table border="1" bgcolor="#007F7F" cellpadding="2" summary="">
<tr>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt=
"boost.png (6897 bytes)" width="277" height="86"></td>
<table border="1" bgcolor="#007F7F" cellpadding="2"> <td><a href="../index.htm"><font face="Arial,Helvetica" color=
<tr> "#FFFFFF"><big>Home</big></font></a></td>
<td bgcolor="#FFFFFF"><img src="../boost.png" alt="boost.png (6897 bytes)" width="277" height="86"></td>
<td><a href="../index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Home</big></font></a></td>
<td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>Libraries</big></font></a></td>
<td><a href="../people/people.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>People</big></font></a></td>
<td><a href="faq.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>FAQ</big></font></a></td>
<td><a href="index.htm"><font face="Arial,Helvetica" color="#FFFFFF"><big>More</big></font></a></td>
</tr>
</table>
<p> <td><a href="../libs/libraries.htm"><font face="Arial,Helvetica" color=
"#FFFFFF"><big>Libraries</big></font></a></td>
<h1>Portability Hints: Microsoft Visual C++ 6.0 SP4</h1> <td><a href="../people/people.htm"><font face="Arial,Helvetica" color=
"#FFFFFF"><big>People</big></font></a></td>
Similar to the <td><a href="faq.htm"><font face="Arial,Helvetica" color=
<a href="borland_cpp.html">portability hints for Borland C++</a>, "#FFFFFF"><big>FAQ</big></font></a></td>
this page provides hints on some language features of the Microsoft Visual C++
version 6.0 service pack 4 compiler. A list of
acknowledged deficiencies can be found at the
<a href="http://support.microsoft.com/support/kb/articles/q243/4/51.asp">Microsoft support site</a>.
<p>
Each entry in the following list describes a particular issue, <td><a href="index.htm"><font face="Arial,Helvetica" color=
complete with sample source code to demonstrate the effect. "#FFFFFF"><big>More</big></font></a></td>
Most sample code herein has been verified to compile with gcc 2.95.2 </tr>
and Comeau C++ 4.2.44. </table>
<h1>Portability Hints: Microsoft Visual C++ 6.0 SP4</h1>
<h2>Preprocessor symbol</h2> <p>Similar to the <a href="borland_cpp.html">portability hints for Borland
C++</a>, this page provides hints on some language features of the
Microsoft Visual C++ version 6.0 service pack 4 compiler. A list of
acknowledged deficiencies can be found at the <a href=
"http://support.microsoft.com/support/kb/articles/q243/4/51.asp">Microsoft
support site</a>.</p>
The preprocessor symbol <code>_MSC_VER</code> is defined for all <p>Each entry in the following list describes a particular issue, complete
Microsoft C++ compilers. Its value is the internal version number of the with sample source code to demonstrate the effect. Most sample code herein
compiler interpreted as a decimal number. Since a few other compilers has been verified to compile with gcc 2.95.2 and Comeau C++ 4.2.44.</p>
also define this symbol, boost provides the symbol
<code>BOOST_MSVC</code>, which is defined in
<a href="../boost/config.hpp">boost/config.hpp</a>
to the value of _MSC_VER if and only if the compiler is really
Microsoft Visual C++.
The following table lists some known values. <h2>Preprocessor symbol</h2>
<p>
<table border="1"> <p>The preprocessor symbol <code>_MSC_VER</code> is defined for all
<tr> Microsoft C++ compilers. Its value is the internal version number of the
<th>Compiler</th> compiler interpreted as a decimal number. Since a few other compilers also
<th><code>BOOST_MSVC</code> value</th> define this symbol, boost provides the symbol <code>BOOST_MSVC</code>,
</tr> which is defined in <a href="../boost/config.hpp">boost/config.hpp</a> to
the value of _MSC_VER if and only if the compiler is really Microsoft
Visual C++. The following table lists some known values.</p>
<tr> <table border="1" summary="">
<td>Microsoft Visual C++ 6.0 (up to SP6)</td> <tr>
<td>1200</td> <th>Compiler</th>
</tr>
<tr> <th><code>BOOST_MSVC</code> value</th>
<td>Microsoft embedded Visual C++ 4.0</td> </tr>
<td>1200-1202 (cross compilers)</td>
</tr>
</table> <tr>
<td>Microsoft Visual C++ 6.0 (up to SP6)</td>
<td>1200</td>
</tr>
<h2>Core Language</h2> <tr>
<td>Microsoft embedded Visual C++ 4.0</td>
<h3>[chained using] Chaining <code>using</code>-declarations</h3> <td>1200-1202 (cross compilers)</td>
</tr>
</table>
Chaining <code>using</code>-declarations does not work. <h2>Core Language</h2>
<pre>
<h3>[chained using] Chaining <code>using</code>-declarations</h3>
<p>Chaining <code>using</code>-declarations does not work.</p>
<pre>
void f(); void f();
namespace N { namespace N {
@ -86,39 +92,33 @@ void g()
} }
</pre> </pre>
<h3>[explicit-instantiation] Explicit function template instantiation</h3>
<h3>[explicit-instantiation] Explicit function template <p>Trying to explicitly instantiate a function template leads to the wrong
instantiation</h3> function being called silently.</p>
<pre>
Trying to explicitly instantiate a function template leads to the
wrong function being called silently.
<pre>
#include &lt;stdio.h&gt; #include &lt;stdio.h&gt;
template&lt;class T&gt; template&lt;class T&gt;
void f() void f()
{ {
printf(&quot;%d\n&quot;, sizeof(T)); printf("%d\n", sizeof(T));
} }
int main() int main()
{ {
f&lt;double&gt;(); // output: &quot;1&quot; f&lt;double&gt;(); // output: "1"
f&lt;char&gt;(); // output: &quot;1&quot; f&lt;char&gt;(); // output: "1"
return 0; return 0;
} }
</pre> </pre>
<h3>[for-scoping] Scopes of definitions in for-loops</h3>
<h3>[for-scoping] Scopes of definitions in for-loops</h3> <p>The scope of variable definitions in <code>for</code> loops should be
local to the loop's body, but it is instead local to the enclosing
The scope of variable definitions in <code>for</code> loops should be block.</p>
local to the loop's body, but it is instead local to the enclosing <pre>
block.
<pre>
int main() int main()
{ {
for(int i = 0; i &lt; 5; ++i) for(int i = 0; i &lt; 5; ++i)
@ -129,51 +129,46 @@ int main()
} }
</pre> </pre>
<strong>Workaround:</strong> Enclose the offending <code>for</code> <p><strong>Workaround:</strong> Enclose the offending <code>for</code>
loops in another pair of curly braces. loops in another pair of curly braces.</p>
<p>
Another possible workaround (brought to my attention by Vesa Karvonen) <p>Another possible workaround (brought to my attention by Vesa Karvonen)
is this: is this:</p>
<pre> <pre>
#ifndef for #ifndef for
#define for if (0) {} else for #define for if (0) {} else for
#endif #endif
</pre> </pre>
Note that platform-specific inline functions in included headers might <p>Note that platform-specific inline functions in included headers might
depend on the old-style <code>for</code> scoping. depend on the old-style <code>for</code> scoping.</p>
<h3>[inclass-member-init] In-class member initialization</h3>
<h3>[inclass-member-init] In-class member initialization</h3> <p>In-class member initialization, required to implement a
Standard-conforming <code>std::numeric_limits</code> template, does not
In-class member initialization, required to implement a work.</p>
Standard-conforming <code>std::numeric_limits</code> template, does <pre>
not work.
<pre>
struct A struct A
{ {
static const int i = 5; // &quot;invalid syntax for pure virtual method&quot; static const int i = 5; // "invalid syntax for pure virtual method"
}; };
</pre> </pre>
<strong>Workaround:</strong> Either use an enum (which has incorrect <p><strong>Workaround:</strong> Either use an enum (which has incorrect
type, but can be used in compile-time constant expressions), or define type, but can be used in compile-time constant expressions), or define the
the value out-of-line (which allows for the correct type, but prohibits value out-of-line (which allows for the correct type, but prohibits using
using the constant in compile-time constant expressions). See the constant in compile-time constant expressions). See <a href=
<a href="int_const_guidelines.htm">Coding Guidelines for Integral Constant Expressions</a> "int_const_guidelines.htm">Coding Guidelines for Integral Constant
for guidelines how to define member constants portably in boost Expressions</a> for guidelines how to define member constants portably in
libraries. boost libraries.</p>
<h3>[koenig-lookup] Argument-dependent lookup</h3>
<h3>[koenig-lookup] Argument-dependent lookup</h3> <p>Argument-dependent lookup, also called Koenig lookup, works for
overloaded operators, but not for ordinary functions. No additional
Argument-dependent lookup, also called Koenig lookup, works for namespaces induced from the argument types seem to be considered.</p>
overloaded operators, but not for ordinary functions. No <pre>
additional namespaces induced from the argument types seem to be
considered.
<pre>
namespace N { namespace N {
struct A {}; struct A {};
void f(A); void f(A);
@ -186,29 +181,26 @@ void g()
} }
</pre> </pre>
<h3>[template-friend] Templates as friends</h3>
<h3>[template-friend] Templates as friends</h3> <p>A Template cannot be declared a friend of a class.</p>
<pre>
A Template cannot be declared a friend of a class.
<pre>
template&lt;class T&gt; template&lt;class T&gt;
struct A {}; struct A {};
struct B struct B
{ {
template&lt;class T&gt; template&lt;class T&gt;
friend struct A; // &quot;syntax error&quot; friend struct A; // "syntax error"
}; };
</pre> </pre>
<h3>[member-template-outofline] Out-of-line definitions of member
templates</h3>
<h3>[member-template-outofline] Out-of-line definitions of member <p>Defining member templates outside their enclosing class does not
templates</h3> work.</p>
<pre>
Defining member templates outside their enclosing class does not work.
<pre>
template&lt;class T&gt; template&lt;class T&gt;
struct A struct A
{ {
@ -217,21 +209,19 @@ struct A
}; };
template&lt;class T&gt; template&lt;class T&gt;
template&lt;class U&gt; // &quot;syntax error&quot; template&lt;class U&gt; // "syntax error"
void A&lt;T&gt;::f() // &quot;T: undeclared identifier&quot; void A&lt;T&gt;::f() // "T: undeclared identifier"
{ {
} }
</pre> </pre>
<strong>Workaround:</strong> Define member templates in-line within <p><strong>Workaround:</strong> Define member templates in-line within
their enclosing class. their enclosing class.</p>
<h3>[partial-spec] Partial specialization</h3>
<h3>[partial-spec] Partial specialization</h3> <p>Partial specialization of class templates does not work.</p>
<pre>
Partial specialization of class templates does not work.
<pre>
template&lt;class T&gt; template&lt;class T&gt;
struct A {}; struct A {};
@ -242,52 +232,45 @@ template&lt;class T&gt;
struct A&lt;B&lt;T&gt; &gt; {}; // template class was already defined as a non-template struct A&lt;B&lt;T&gt; &gt; {}; // template class was already defined as a non-template
</pre> </pre>
<strong>Workaround:</strong> In some situations where interface <p><strong>Workaround:</strong> In some situations where interface does not
does not matter, class member templates can simulate partial matter, class member templates can simulate partial specialization.</p>
specialization.
<h3>[template-value] Dependent template value parameters</h3>
<h3>[template-value] Dependent template value parameters</h3> <p>Template value parameters whose type depends on a previous template
parameter provoke an internal compiler error if the correct syntax (with
Template value parameters whose type depends on a previous template "typename") is used.</p>
parameter provoke an internal compiler error if the correct syntax <pre>
(with "typename") is used.
<pre>
template&lt;class T, typename T::result_type&gt; // C1001: INTERNAL COMPILER ERROR: msc1.cpp, line 1794 template&lt;class T, typename T::result_type&gt; // C1001: INTERNAL COMPILER ERROR: msc1.cpp, line 1794
struct B {}; struct B {};
// (omit &quot;typename&quot; and it compiles) // (omit "typename" and it compiles)
</pre> </pre>
<strong>Workaround:</strong> Leave off the "typename" keyword. That makes <p><strong>Workaround:</strong> Leave off the "typename" keyword. That
the program non-conforming, though. makes the program non-conforming, though.</p>
<h3>[wchar_t] <code>wchar_t</code> is not built-in</h3>
<h3>[wchar_t] <code>wchar_t</code> is not built-in</h3> <p>The type <code>wchar_t</code> is not a built-in type.</p>
<pre>
The type <code>wchar_t</code> is not a built-in type. wchar_t x; // "missing storage class or type identifier"
<pre>
wchar_t x; // &quot;missing storage class or type identifier&quot;
</pre> </pre>
<strong>Workaround:</strong> When using Microsoft Visual C++, the <p><strong>Workaround:</strong> When using Microsoft Visual C++, the header
header <a href="../boost/config.hpp">boost/config.hpp</a> includes
<a href="../boost/config.hpp">boost/config.hpp</a> <code>&lt;cstddef&gt;</code>, which defines <code>wchar_t</code> as a
includes <code>&lt;cstddef></code>, which defines typedef for <code>unsigned short</code>. Note that this means that the
<code>wchar_t</code> as a typedef for <code>unsigned compiler does not regard <code>wchar_t</code> and <code>unsigned
short</code>. Note that this means that the compiler does not regard short</code> as distinct types, as is required by the standard, and so
<code>wchar_t</code> and <code>unsigned short</code> as distinct ambiguities may emanate when overloading on <code>wchar_t</code>. The macro
types, as is required by the standard, and so ambiguities may emanate <code>BOOST_NO_INTRINSIC_WCHAR_T</code> is defined in this situation.</p>
when overloading on <code>wchar_t</code>. The macro
<code>BOOST_NO_INTRINSIC_WCHAR_T</code> is defined in this situation.
<h3>[delete-const-pointer] Deleting <code>const X *</code> does not
work</h3>
<h3>[delete-const-pointer] Deleting <code>const X *</code> does not work</h3> <p>Trying to delete a pointer to a cv-qualified type gives an error:</p>
<pre>
Trying to delete a pointer to a cv-qualified type gives an error:
<pre>
void f() void f()
{ {
const int *p = new int(5); const int *p = new int(5);
@ -295,29 +278,49 @@ void f()
} }
</pre> </pre>
<strong>Workaround:</strong> Define the function <p><strong>Workaround:</strong> Define the function</p>
<pre> <pre>
inline void operator delete(const void *p) throw() inline void operator delete(const void *p) throw()
{ operator delete(const_cast&lt;void*>(p)); } { operator delete(const_cast&lt;void*&gt;(p)); }
</pre> </pre>
and similar functions for the other cv-qualifier combinations, for
operator delete[], and for the <code>std::nothrow</code> variants.
<p>and similar functions for the other cv-qualifier combinations, for
operator delete[], and for the <code>std::nothrow</code> variants.</p>
<h2>Standard Library</h2>
<h2>Standard Library</h2> <h3>[clib-namespace] C library names in global namespace instead of
std</h3>
<h3>[clib-namespace] C library names in global namespace instead of std</h3> <p>Library names from the &lt;c...&gt; headers are in the global namespace
<p>Library names from the &lt;c...&gt; headers are in the global namespace instead of namespace std.</p>
instead of namespace std.<p><b>Workaround:</b>&nbsp; The header <a href="../libs/config/config.htm">boost/config.hpp</a>
will define BOOST_NO_STDC_NAMESPACE. It can be used as follows: <p><b>Workaround:</b>&nbsp; The header <a href=
<pre># ifdef BOOST_NO_STDC_NAMESPACE "../libs/config/config.htm">boost/config.hpp</a> will define
BOOST_NO_STDC_NAMESPACE. It can be used as follows:</p>
<pre>
# ifdef BOOST_NO_STDC_NAMESPACE
namespace std { using ::abs; using ::fabs; } namespace std { using ::abs; using ::fabs; }
# endif</pre> # endif
<p>Because std::size_t and std::ptrdiff_t are so commonly used, the workaround </pre>
for these is already provided in boost/config.hpp.<p>&nbsp;
<hr>
2001-05-04 <a href="../people/jens_maurer.htm">Jens Maurer</a> <p>Because std::size_t and std::ptrdiff_t are so commonly used, the
workaround for these is already provided in boost/config.hpp.</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04 December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2001-2002 <a href="../people/jens_maurer.htm">Jens
Maurer</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or copy
at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

921
writingdoc/design.html
View File

@ -1,377 +1,576 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Writing Documentation for Boost - HTML Design</title> <link rel="stylesheet" type="text/css" href="../../boost.css">
<title>Writing Documentation for Boost - HTML Design</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="index.html"><img height="86" width="277" alt="C++ Boost" src="../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost"
<td valign="top"> src="../../boost.png" border="0"></a></h3>
<h1 align="center">Writing Documentation for Boost</h1> </td>
<h2 align="center">HTML Design</h2>
</td> <td valign="top">
</tr> <h1 align="center">Writing Documentation for Boost</h1>
</table>
<hr> <h2 align="center">HTML Design</h2>
<dl class="page-index"> </td>
<dt><a href="#introduction">Introduction</a></dt> </tr>
<dt><a href="#common-pages">Common Pages Included in HTML Documentation</a></dt> </table>
<dl class="page-index"> <hr>
<dt><a href="#index-page">Index</a></dt>
<dt><a href="#overview-page">Overview</a></dt> <dl class="page-index">
<dt><a href="#definitions-page">Definitions</a></dt> <dt><a href="#introduction">Introduction</a></dt>
<dt><a href="#rationale-page">Rationale</a></dt>
<dt><a href="#configuration-page">Configuration Information</a></dt> <dt><a href="#common-pages">Common Pages Included in HTML
<dt><a href="#faq-page">Frequently Asked Questions</a></dt> Documentation</a></dt>
<dt><a href="#bibliography-page">Bibliography</a></dt>
<dt><a href="#acknowledgements-page">Acknowledgment</a></dt> <dd>
<dt><a href="#header-page">Header Reference</a></dt> <dl class="page-index">
<dt><a href="#index-page">Index</a></dt>
<dt><a href="#overview-page">Overview</a></dt>
<dt><a href="#definitions-page">Definitions</a></dt>
<dt><a href="#rationale-page">Rationale</a></dt>
<dt><a href="#configuration-page">Configuration Information</a></dt>
<dt><a href="#faq-page">Frequently Asked Questions</a></dt>
<dt><a href="#bibliography-page">Bibliography</a></dt>
<dt><a href="#acknowledgements-page">Acknowledgment</a></dt>
<dt><a href="#header-page">Header Reference</a></dt>
</dl>
</dd>
<dt><a href="#layout">Layout</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#page-banner">Page Banner</a></dt>
<dt><a href="#page-index">Page Index</a></dt>
<dt><a href="#content">Documentation Content</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#doc-footnotes">Footnotes</a></dt>
</dl>
</dd>
<dt><a href="#revision-info">Revision Information</a></dt>
<dt><a href="#copyright">Copyright Information</a></dt>
</dl>
</dd>
<dt><a href="#format">Format</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#style-sheets">Cascading Style Sheets</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#boost-style-sheet">Boost Style Sheet</a></dt>
</dl>
</dd>
</dl>
</dd>
<dt><a href="#templates">Templates</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#index-template">Index Page Template</a></dt>
<dt><a href="#overview-template">Overview Page Template</a></dt>
<dt><a href="#definitions-template">Definitions Page
Template</a></dt>
<dt><a href="#rationale-template">Rationale Page Template</a></dt>
<dt><a href="#configuration-template">Configuration Page
Template</a></dt>
<dt><a href="#faq-template">FAQ (Frequently Asked Questions) Page
Template</a></dt>
<dt><a href="#bibliography-template">Bibliography Page
Template</a></dt>
<dt><a href="#acknowledgements-template">Acknowledgments Page
Template</a></dt>
<dt><a href="#header-template">Header Page Template</a></dt>
</dl>
</dd>
</dl> </dl>
<dt><a href="#layout">Layout</a></dt>
<dl class="page-index"> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
<dt><a href="#page-banner">Page Banner</a></dt>
<dt><a href="#page-index">Page Index</a></dt> <p>Boost places no requirements on the design of HTML documentation for
<dt><a href="#content">Documentation Content</a></dt> library submitters. If you are submitting a library for which documentation
<dl class="page-index"> already exists in either HTML or in a form easily converted to HTML then
<dt><a href="#doc-footnotes">Footnotes</a></dt> there is no need for you to read this document. However, if you have not
</dl> yet written the documentation, or if you expect to have to translate
<dt><a href="#revision-info">Revision Information</a></dt> documentation written in a format not easily convertible to HTML then this
<dt><a href="#copyright">Copyright Information</a></dt> document can give you a lot of information on how to go about writing
</dl> documentation in HTML.</p>
<dt><a href="#format">Format</a></dt>
<dl class="page-index"> <p>In several places this document assumes you're writing the documentation
<dt><a href="#style-sheets">Cascading Style Sheets</a></dt> to conform to the structure described in the <a href=
<dl class="page-index"> "structure.html">Documentation Structure</a> document. There is no
<dt><a href="#boost-style-sheet">Boost Style Sheet</a></dt> requirement that your documentation content follow these guidelines, but
</dl> they provide an effective way to communicate technical specifications for a
</dl> library in a terse yet precise manner that's familiar to many Boost
<dt><a href="#templates">Templates</a></dt> users.</p>
<dl class="page-index">
<dt><a href="#index-template">Index Page Template</a></dt> <p>This document also contains links to <a href="#templates">HTML template
<dt><a href="#overview-template">Overview Page Template</a></dt> files</a> that can be used to rapidly develop documentation for a library
<dt><a href="#definitions-template">Definitions Page Template</a></dt> submission. These templates follow the guidelines presented here and in the
<dt><a href="#rationale-template">Rationale Page Template</a></dt> <a href="structure.html">Documentation Structure</a> document.</p>
<dt><a href="#configuration-template">Configuration Page Template</a></dt>
<dt><a href="#faq-template">FAQ (Frequently Asked Questions) Page Template</a></dt> <h2><a name="common-pages" id="common-pages"></a>Common Pages Included in
<dt><a href="#bibliography-template">Bibliography Page Template</a></dt> HTML Documentation</h2>
<dt><a href="#acknowledgements-template">Acknowledgments Page Template</a></dt>
<dt><a href="#header-template">Header Page Template</a></dt> <p>Most HTML documentation projects will contain some common pages. General
</dl> guidelines for these common pages are provided below.</p>
</dl>
<h2><a name="introduction"></a>Introduction</h2> <h3><a name="index-page" id="index-page"></a>Index</h3>
<p>Boost places no requirements on the design of HTML documentation for library
submitters. If you are submitting a library for which documentation already <p>The index page is the first page presented to a user when he browses the
exists in either HTML or in a form easily converted to HTML then there is no documentation. Generally this page should not contain any actual content,
need for you to read this document. However, if you have not yet written the but instead contains a list of links to specific content. At a minimum this
documentation, or if you expect to have to translate documentation written in list should contain a link to every HTML page contained in the
a format not easily convertible to HTML then this document can give you a lot documentation. Optionally, sub-lists may be provided for individual pages
of information on how to go about writing documentation in HTML.</p> linking to specific subjects within the page. These sub-lists should form a
<p>In several places this document assumes you're writing the documentation to "tree" hierarchy based on the level of heading tag used for the specific
conform to the structure described in the <a href="structure.html">Documentation subject. Inclusion of such sub-lists for every page can make the index
Structure</a> document. There is no requirement that your documentation content rather lengthy, and since each page should include its own <a href=
follow these guidelines, but they provide an effective way to communicate technical "#page-index">Page Index</a>, it may make the navigation of the
specifications for a library in a terse yet precise manner that's familiar to documentation easier if such sub-lists are avoided. However, there is one
many Boost users.</p> exception to this guideline: reference documentation should contain a link
<p>This document also contains links to <a href="#templates">HTML template files</a> to every header file in the library and a sub-list with a link to every
that can be used to rapidly develop documentation for a library submission. macro, value, type, class, function and object (see <a href=
These templates follow the guidelines presented here and in the <a href="structure.html">Documentation "structure.html">Documentation Structure</a>) found in the header. Users
Structure</a> document.</p> aren't always sure what header file any of these may be contained in, so
<h2><a name="common-pages"></a>Common Pages Included in HTML Documentation</h2> this structure in the index allows for easy navigation of the reference
<p>Most HTML documentation projects will contain some common pages. General guidelines documentation.</p>
for these common pages are provided below.</p>
<h3><a name="index-page"></a>Index</h3> <p>The index list should generally be constructed using an HTML "definition
<p>The index page is the first page presented to a user when he browses the documentation. list" (&lt;dl&gt; and &lt;dt&gt; tags). A definition list has no bullets or
Generally this page should not contain any actual content, but instead contains ordered specifications and produces a cleaner layout then an unordered list
a list of links to specific content. At a minimum this list should contain a (&lt;ul&gt; and &lt;li&gt; tags) or an ordered list (&lt;ol&gt; and
link to every HTML page contained in the documentation. Optionally, sub-lists &lt;li&gt; tags). If you choose to use the common <a href=
may be provided for individual pages linking to specific subjects within the "#boost-style-sheet">Boost Style Sheet</a> you should add a
page. These sub-lists should form a &quot;tree&quot; hierarchy based on the <code>class="index"</code> attribute/value pair to the &lt;dl&gt; tag.</p>
level of heading tag used for the specific subject. Inclusion of such sub-lists
for every page can make the index rather lengthy, and since each page should <p>An Index page <a href="#index-template">template</a> is provided for
include its own <a href="#page-index">Page Index</a>, it may make the navigation
of the documentation easier if such sub-lists are avoided. However, there is
one exception to this guideline: reference documentation should contain a link
to every header file in the library and a sub-list with a link to every macro,
value, type, class, function and object (see <a href="structure.html">Documentation
Structure</a>) found in the header. Users aren't always sure what header file
any of these may be contained in, so this structure in the index allows for
easy navigation of the reference documentation.</p>
<p>The index list should generally be constructed using an HTML &quot;definition
list&quot; (&lt;dl&gt; and &lt;dt&gt; tags). A definition list has no bullets
or ordered specifications and produces a cleaner layout then an unordered list
(&lt;ul&gt; and &lt;li&gt; tags) or an ordered list (&lt;ol&gt; and &lt;li&gt;
tags). If you choose to use the common <a href="#boost-style-sheet">Boost Style
Sheet</a> you should add a <code>class="index"</code> attribute/value pair to
the &lt;dl&gt; tag.</p>
<p>An Index page <a href="#index-template">template</a> is provided for use.</p>
<h3><a name="overview-page"></a>Overview</h3>
<p>The Overview page is used to introduce the reader to the library. It should
give a high-level overview of the purpose of the library and introduce the reader
to any concepts they may be unfamiliar with. This may also be an appropriate
place for some &quot;light&quot; rationale, though more thorough presentation
of any rationale would be better placed in the <a href="#rationale-page">Rational
Page</a>.</p>
<p>Like most content pages, the Overview page should include a <a href="#page-index">Page
Index</a>.</p>
<p>An Overview page <a href="#overview-template">template</a> is provided for
use.</p> use.</p>
<h3><a name="definitions-page"></a>Definitions</h3>
<p>The Definitions page is used to provide a list of definitions for terms that <h3><a name="overview-page" id="overview-page"></a>Overview</h3>
a user may be unfamiliar with.</p>
<p>The definition list should generally be constructed using an HTML &quot;definition <p>The Overview page is used to introduce the reader to the library. It
list&quot; (&lt;dl&gt; and &lt;DT&gt; tags). A definition list has no bullets should give a high-level overview of the purpose of the library and
or ordered specifications and produces a cleaner layout then an unordered list introduce the reader to any concepts they may be unfamiliar with. This may
(&lt;UL&gt; and &lt;li&gt; tags) or an ordered list (&lt;ol&gt; and &lt;li&gt; also be an appropriate place for some "light" rationale, though more
tags). If you choose to use the common <a href="#boost-style-sheet">Boost Style thorough presentation of any rationale would be better placed in the
Sheet</a> you should add a <code>class="definition"</code> attribute/value pair <a href="#rationale-page">Rational Page</a>.</p>
to the &lt;dl&gt; tag.</p>
<p>Because this page's content should only contain a list of definitions, it should <p>Like most content pages, the Overview page should include a <a href=
not have a <a href="#page-index">Page Index</a>.</p> "#page-index">Page Index</a>.</p>
<p></p>
<p> A Definitions page <a href="#definitions-template">template</a> is provided <p>An Overview page <a href="#overview-template">template</a> is provided
for use.</p> for use.</p>
<h3><a name="rationale-page"></a>Rationale</h3>
<p>The Rationale page is used to provide lengthy descriptions of the rationale <h3><a name="definitions-page" id="definitions-page"></a>Definitions</h3>
behind the library's design. This information helps users to understand why
a library was designed the way it was and may reduce the frequency of a number <p>The Definitions page is used to provide a list of definitions for terms
of frequently asked questions. For a better description of why rationale is that a user may be unfamiliar with.</p>
important see the <a href="http://www.boost.org/more/lib_guide.htm#Rationale">Rationale
rationale</a> in the general submission guidelines.</p> <p>The definition list should generally be constructed using an HTML
<p>Like most content pages, the Rationale page should include a <a href="#page-index">Page "definition list" (&lt;dl&gt; and &lt;DT&gt; tags). A definition list has
Index</a>.</p> no bullets or ordered specifications and produces a cleaner layout then an
<p></p> unordered list (&lt;UL&gt; and &lt;li&gt; tags) or an ordered list
<p>A Rationale page <a href="#rationale-template">template</a> is provided for (&lt;ol&gt; and &lt;li&gt; tags). If you choose to use the common <a href=
use.</p> "#boost-style-sheet">Boost Style Sheet</a> you should add a
<h3><a name="configuration-page"></a>Configuration Information</h3> <code>class="definition"</code> attribute/value pair to the &lt;dl&gt;
<p>The Configuration Information page is used to document configuration macros tag.</p>
used by the library. Such macros belong in one of three groups: macros used
by library implenters defined in <code>&lt;boost/config.hpp&gt;</code>, macros <p>Because this page's content should only contain a list of definitions,
used by library users to detect platform configuration information and macros it should not have a <a href="#page-index">Page Index</a>.</p>
defined by library users to configure library behavior.</p>
<p>Like most content pages, the Overview page should include a <a href="#page-index">Page <p>A Definitions page <a href="#definitions-template">template</a> is
Index</a>.</p>
<p></p>
<p>A Configuration page <a href="#configuration-template">template</a> is provided
for use.</p>
<h3><a name="faq-page"></a>Frequently Asked Questions</h3>
<p>As a library matures the users will have questions about the usage of the library.
Often users will ask the same questions over and over again. Rather than having
to deal with answering the question every time it's asked, a Frequently Asked
Questions (commonly known as FAQs) page can be used to document the questions
and answers. This is such a valuable piece of documentation not only for the
users but for the maintainers as well, that a FAQ page should be provided from
the outset. If there are no questions that will obviously become a FAQ, the
initial page may just indicate that there are no FAQs yet. This empty place
holder helps to indicate to the users that you plan to address any FAQs as they
occur.</p>
<p>The <a href="#page-index">Page Index</a> for the FAQ page should contain a
list of all the questions contained in the document. The actual question entries
should be formatted with the question in a heading tag and the answers in standard
paragraph format. This provides a clean presentation that's easy to read.</p>
<p>A Frequently Asked Questions page <a href="#faq-template">template</a> is provided
for use.</p>
<h3><a name="bibliography-page"></a>Bibliography</h3>
<p>The Bibliography page is used to document any bibliographical information associated
with references made within the documentation to external resources. Parenthetical
references are used within the documentation which link to entries in the Bibliography
page. Bibliographical entries provide detailed information about the external
resource and may contain hyper links to the resource if it's available online.
There are several formal styles used for writing bibliographies. You may use
what ever style you want, but one of the better styles to consider using can
be referenced <a href="http://www.columbia.edu/cu/cup/cgos/idx_basic.html">here</a>.</p>
<p>Since the Bibliography page should contain only bibliographical information
there is no need for a <a href="#page-index">Page Index</a>.</p>
<p>A Bibliography page <a href="#bibliography-template">template</a> is provided
for use.</p>
<h3><a name="acknowledgements-page"></a>Acknowledgment</h3>
<p>The Acknowledgment page is used to give credit where credit is due. When individuals
provide input on the design or implementation, or when you make use of someone
else's work, you should acknowledge them. This is a courtesy that you'd expect
others to extend to you, so you should strive to acknowledge the efforts of
everyone else in your own documentation.</p>
<p>Since the Acknowledgment page should contain only a list of acknowledgment
there is no need for a <a href="#page-index">Page Index</a>.</p>
<p>An Acknowledgments page <a href="#acknowledgements-template">template</a> is
provided for use.</p> provided for use.</p>
<h3><a name="header-page"></a>Header Reference</h3>
<p>The Header Reference pages are the most important pages in your documentation. <h3><a name="rationale-page" id="rationale-page"></a>Rationale</h3>
They document all library headers, including all the macros, values, types,
classes, functions and objects defined in them. In general it may prove useful <p>The Rationale page is used to provide lengthy descriptions of the
to follow the guidelines in <a href="structure.html">Documentation Structure</a> rationale behind the library's design. This information helps users to
when writing the content for these pages.</p> understand why a library was designed the way it was and may reduce the
<p>Like most content pages, the Header Reference pages should include a <a href="#page-index">Page frequency of a number of frequently asked questions. For a better
Index</a>.</p> description of why rationale is important see the <a href=
<p>A Header Reference page <a href="#header-template">template</a> is provided "http://www.boost.org/more/lib_guide.htm#Rationale">Rationale rationale</a>
in the general submission guidelines.</p>
<p>Like most content pages, the Rationale page should include a <a href=
"#page-index">Page Index</a>.</p>
<p>A Rationale page <a href="#rationale-template">template</a> is provided
for use.</p> for use.</p>
<h2><a name="layout"></a>Layout</h2>
<p>There are certain page layout concepts that will be used frequently in many <h3><a name="configuration-page" id="configuration-page"></a>Configuration
of your pages. This section outlines some general guidelines that you can follow Information</h3>
when designing each of these layout concepts for your documentation.</p>
<h3><a name="page-banner"></a>Page Banner</h3> <p>The Configuration Information page is used to document configuration
<p>The Page Banner is located at the very top of a page and provides quick information macros used by the library. Such macros belong in one of three groups:
about the page contents. This includes the Boost logo, which indicates to the macros used by library implenters defined in
reader that this page is part of the Boost web site, a title for the documentation <code>&lt;boost/config.hpp&gt;</code>, macros used by library users to
(generally the library name) and the page title. The Boost logo should hyper detect platform configuration information and macros defined by library
link to the Boost home page on the index page and to the index page on all other users to configure library behavior.</p>
pages. This allows the user to easily navigate through the Boost web site and
through the documentation. The &lt;title&gt; tag for the HTML page should consist <p>Like most content pages, the Overview page should include a <a href=
of the documentation title and the page title separated by a hyphen.</p> "#page-index">Page Index</a>.</p>
<p>The Page Banner should be separated from the rest of the page by the use of
an &lt;hr&gt; tag. This helps to clearly separate the actual content from the <p>A Configuration page <a href="#configuration-template">template</a> is
title information and produces cleaner text.</p> provided for use.</p>
<h3><a name="page-index"></a>Page Index</h3>
<p>The page index is used to quickly navigate to the various sections of the documentation <h3><a name="faq-page" id="faq-page"></a>Frequently Asked Questions</h3>
on the page, and when present should be located just below the Page Banner.</p>
<p>The index list should generally be constructed using an HTML &quot;definition <p>As a library matures the users will have questions about the usage of
list&quot; (&lt;dl&gt; and &lt;DT&gt; tags). A definition list has no bullets the library. Often users will ask the same questions over and over again.
or ordered specifications and produces a cleaner layout then an unordered list Rather than having to deal with answering the question every time it's
(&lt;UL&gt; and &lt;li&gt; tags) or an ordered list (&lt;ol&gt; and &lt;li&gt; asked, a Frequently Asked Questions (commonly known as FAQs) page can be
tags). If you choose to use the Boost Style Sheet you should add a <code>class="page-index"</code> used to document the questions and answers. This is such a valuable piece
attribute/value pair to the &lt;dl&gt; tag.</p> of documentation not only for the users but for the maintainers as well,
<p>Most pages should include a Page Index.</p> that a FAQ page should be provided from the outset. If there are no
<h3><a name="content"></a>Documentation Content</h3> questions that will obviously become a FAQ, the initial page may just
<p>The page's actual documentation content will be formatted according to the indicate that there are no FAQs yet. This empty place holder helps to
specific needs of individual pages, and should be placed right after the Page indicate to the users that you plan to address any FAQs as they occur.</p>
Index if present, or after the Page Banner if not. In general the documentation
content will take the form of paragraph text contained underneath section headings.</p> <p>The <a href="#page-index">Page Index</a> for the FAQ page should contain
<h3><a name="doc-footnotes"></a>Footnotes</h3> a list of all the questions contained in the document. The actual question
<p>Footnotes may be used within a page's documentation. Within the documentation entries should be formatted with the question in a heading tag and the
content a footnote reference should take the form of a footnote number in parentheses answers in standard paragraph format. This provides a clean presentation
(the parentheses make it easier for the reader to click on the hyper link) hyper that's easy to read.</p>
linking to the actual footnote at the bottom of the page's documentation content.
You may either use the &lt;sup&gt; tag to format such footnote numbers, or, <p>A Frequently Asked Questions page <a href="#faq-template">template</a>
preferably, you can use a CSS style class in order to distinguish the number is provided for use.</p>
as a footnote instead of as part of the actual text. If you choose to use the
common <a href="#boost-style-sheet">Boost Style Sheet</a>, a <code>footnote</code> <h3><a name="bibliography-page" id=
"bibliography-page"></a>Bibliography</h3>
<p>The Bibliography page is used to document any bibliographical
information associated with references made within the documentation to
external resources. Parenthetical references are used within the
documentation which link to entries in the Bibliography page.
Bibliographical entries provide detailed information about the external
resource and may contain hyper links to the resource if it's available
online. There are several formal styles used for writing bibliographies.
You may use what ever style you want, but one of the better styles to
consider using can be referenced <a href=
"http://www.columbia.edu/cu/cup/cgos/idx_basic.html">here</a>.</p>
<p>Since the Bibliography page should contain only bibliographical
information there is no need for a <a href="#page-index">Page
Index</a>.</p>
<p>A Bibliography page <a href="#bibliography-template">template</a> is
provided for use.</p>
<h3><a name="acknowledgements-page" id=
"acknowledgements-page"></a>Acknowledgment</h3>
<p>The Acknowledgment page is used to give credit where credit is due. When
individuals provide input on the design or implementation, or when you make
use of someone else's work, you should acknowledge them. This is a courtesy
that you'd expect others to extend to you, so you should strive to
acknowledge the efforts of everyone else in your own documentation.</p>
<p>Since the Acknowledgment page should contain only a list of
acknowledgment there is no need for a <a href="#page-index">Page
Index</a>.</p>
<p>An Acknowledgments page <a href=
"#acknowledgements-template">template</a> is provided for use.</p>
<h3><a name="header-page" id="header-page"></a>Header Reference</h3>
<p>The Header Reference pages are the most important pages in your
documentation. They document all library headers, including all the macros,
values, types, classes, functions and objects defined in them. In general
it may prove useful to follow the guidelines in <a href=
"structure.html">Documentation Structure</a> when writing the content for
these pages.</p>
<p>Like most content pages, the Header Reference pages should include a
<a href="#page-index">Page Index</a>.</p>
<p>A Header Reference page <a href="#header-template">template</a> is
provided for use.</p>
<h2><a name="layout" id="layout"></a>Layout</h2>
<p>There are certain page layout concepts that will be used frequently in
many of your pages. This section outlines some general guidelines that you
can follow when designing each of these layout concepts for your
documentation.</p>
<h3><a name="page-banner" id="page-banner"></a>Page Banner</h3>
<p>The Page Banner is located at the very top of a page and provides quick
information about the page contents. This includes the Boost logo, which
indicates to the reader that this page is part of the Boost web site, a
title for the documentation (generally the library name) and the page
title. The Boost logo should hyper link to the Boost home page on the index
page and to the index page on all other pages. This allows the user to
easily navigate through the Boost web site and through the documentation.
The &lt;title&gt; tag for the HTML page should consist of the documentation
title and the page title separated by a hyphen.</p>
<p>The Page Banner should be separated from the rest of the page by the use
of an &lt;hr&gt; tag. This helps to clearly separate the actual content
from the title information and produces cleaner text.</p>
<h3><a name="page-index" id="page-index"></a>Page Index</h3>
<p>The page index is used to quickly navigate to the various sections of
the documentation on the page, and when present should be located just
below the Page Banner.</p>
<p>The index list should generally be constructed using an HTML "definition
list" (&lt;dl&gt; and &lt;DT&gt; tags). A definition list has no bullets or
ordered specifications and produces a cleaner layout then an unordered list
(&lt;UL&gt; and &lt;li&gt; tags) or an ordered list (&lt;ol&gt; and
&lt;li&gt; tags). If you choose to use the Boost Style Sheet you should add
a <code>class="page-index"</code> attribute/value pair to the &lt;dl&gt;
tag.</p>
<p>Most pages should include a Page Index.</p>
<h3><a name="content" id="content"></a>Documentation Content</h3>
<p>The page's actual documentation content will be formatted according to
the specific needs of individual pages, and should be placed right after
the Page Index if present, or after the Page Banner if not. In general the
documentation content will take the form of paragraph text contained
underneath section headings.</p>
<h3><a name="doc-footnotes" id="doc-footnotes"></a>Footnotes</h3>
<p>Footnotes may be used within a page's documentation. Within the
documentation content a footnote reference should take the form of a
footnote number in parentheses (the parentheses make it easier for the
reader to click on the hyper link) hyper linking to the actual footnote at
the bottom of the page's documentation content. You may either use the
&lt;sup&gt; tag to format such footnote numbers, or, preferably, you can
use a CSS style class in order to distinguish the number as a footnote
instead of as part of the actual text. If you choose to use the common
<a href="#boost-style-sheet">Boost Style Sheet</a>, a <code>footnote</code>
class is defined for this purpose.</p> class is defined for this purpose.</p>
<h3><a name="revision-info"></a>Revision Information</h3>
<p>At the bottom of every page should be some revision information indicating <h3><a name="revision-info" id="revision-info"></a>Revision
when the page was last revised. This information should be separated from the Information</h3>
rest of the page above by an &lt;hr&gt; tag. The following HTML code snippet
can be used to track this revision information (this code uses some server components <p>At the bottom of every page should be some revision information
that exist on the Boost web site to automatically track revision dates with indicating when the page was last revised. This information should be
out the need for hand editing the date text):</p> separated from the rest of the page above by an &lt;hr&gt; tag. The
<pre>&lt;hr&gt; following HTML code snippet can be used to track this revision information
(this code uses some server components that exist on the Boost web site to
automatically track revision dates with out the need for hand editing the
date text):</p>
<pre>
&lt;hr&gt;
&lt;p&gt;Revised &lt;p&gt;Revised
&lt;!--webbot bot=&quot;Timestamp&quot; S-Type=&quot;EDITED&quot; S-Format=&quot;%d %B, %Y&quot; startspan --&gt; &lt;!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --&gt;
01 January, 2001 01 January, 2001
&lt;!--webbot bot=&quot;Timestamp&quot; endspan i-checksum=&quot;39359&quot; --&gt; &lt;!--webbot bot="Timestamp" endspan i-checksum="39359" --&gt;
&lt;/p&gt; &lt;/p&gt;
</pre> </pre>
<h3><a name="copyright"></a>Copyright Information</h3>
<p>The very bottom of the page should contain any copyright information that applies <h3><a name="copyright" id="copyright"></a>Copyright Information</h3>
to the document.</p>
<h2><a name="format"></a>Format</h2> <p>The very bottom of the page should contain any copyright information
<p>This section provides general guidelines for formatting documentation using that applies to the document.</p>
HTML. The description of the various &quot;common pages&quot; gave specific
details for formatting specific sections of the documentation, which should <h2><a name="format" id="format"></a>Format</h2>
<p>This section provides general guidelines for formatting documentation
using HTML. The description of the various "common pages" gave specific
details for formatting specific sections of the documentation, which should
override these guidelines.</p> override these guidelines.</p>
<h3><a name="code-format"></a>Code</h3>
<p>Code within the documentation should be placed within either &lt;code&gt;&lt;/code&gt; <h3><a name="code-format" id="code-format"></a>Code</h3>
or &lt;pre&gt;&lt;/pre&gt; tags. For code that's placed inline with other text
you use &lt;code&gt;&lt;/code&gt; tags, while &lt;pre&gt;&lt;/pre&gt; tags are <p>Code within the documentation should be placed within either
used for code &quot;blocks&quot;. If a cascading style sheet is used to specify &lt;code&gt;&lt;/code&gt; or &lt;pre&gt;&lt;/pre&gt; tags. For code that's
formatting for these tags, a fixed width sans serif font should be used. This placed inline with other text you use &lt;code&gt;&lt;/code&gt; tags, while
insures that the code is easily distinguishable from the rest of the text. It &lt;pre&gt;&lt;/pre&gt; tags are used for code "blocks". If a cascading
may also be beneficial to set the style for &lt;pre&gt;&lt;/pre&gt; tags to style sheet is used to specify formatting for these tags, a fixed width
indent the text, to help separate code blocks from other structural HTML blocks. sans serif font should be used. This insures that the code is easily
The <a href="#boost-style-sheet">Boost Style Sheet</a> specifies formatting distinguishable from the rest of the text. It may also be beneficial to set
for these tags.</p> the style for &lt;pre&gt;&lt;/pre&gt; tags to indent the text, to help
<p><b>Note:</b> &quot;Code&quot; includes variable names, function names, etc.</p> separate code blocks from other structural HTML blocks. The <a href=
<h3><a name="lists"></a>Lists</h3> "#boost-style-sheet">Boost Style Sheet</a> specifies formatting for these
<p>Lists should be constructed as unordered (&lt;UL&gt; and &lt;li&gt; tags), tags.</p>
ordered (&lt;ol&gt; and &lt;li&gt; tags) or definition (&lt;dl&gt; and &lt;DT&gt;
tags) lists in HTML. You use an unordered list when you need a collection of <p><b>Note:</b> "Code" includes variable names, function names, etc.</p>
items that don't have any kind of logical ordering, such as a list of data types
that are defined by the library and can be used for a template argument. You <h3><a name="lists" id="lists"></a>Lists</h3>
use an ordered list when the collection of items must be grouped in a logical
ordering, such as when enumerating the steps that an action logically performs. <p>Lists should be constructed as unordered (&lt;UL&gt; and &lt;li&gt;
You use a definition list when the list consists of not only items that have tags), ordered (&lt;ol&gt; and &lt;li&gt; tags) or definition (&lt;dl&gt;
no logical ordering, but also contains definitions/descriptions/etc. of the and &lt;DT&gt; tags) lists in HTML. You use an unordered list when you need
items. A good example of this is the function specifications as described in a collection of items that don't have any kind of logical ordering, such as
<a href="structure.html">Documentation Structure</a>.</p> a list of data types that are defined by the library and can be used for a
<h3><a name="graphics"></a>Graphics</h3> template argument. You use an ordered list when the collection of items
<p>Graphics should be used very sparingly, if at all. Graphic images greatly effect must be grouped in a logical ordering, such as when enumerating the steps
the download time for many people, which can discourage users from reading the that an action logically performs. You use a definition list when the list
documentation. If you need graphic images to help illustrate something in your consists of not only items that have no logical ordering, but also contains
documentation consider supplying only a link to the image within the documentation, definitions/descriptions/etc. of the items. A good example of this is the
instead of embedding it directly in the text. If an image is going to be included function specifications as described in <a href=
in the text of the document you should specify the image's size in the &lt;img&gt; "structure.html">Documentation Structure</a>.</p>
tag, in order to allow the user's browser to optimize the formatting of the
text before the image is loaded.</p> <h3><a name="graphics" id="graphics"></a>Graphics</h3>
<h3><a name="non-breaking-spaces"></a>Non-breaking Spaces</h3>
<p>Non-breaking spaces (&amp;nbsp;) should be avoided in HTML text. Generally <p>Graphics should be used very sparingly, if at all. Graphic images
there are more appropriate ways to format the document, such as using list constructs greatly effect the download time for many people, which can discourage
or specifying indentation as a style attribute or in cascading style sheets.</p> users from reading the documentation. If you need graphic images to help
<h3><a name="style-sheets"></a>Cascading Style Sheets</h3> illustrate something in your documentation consider supplying only a link
<p>Cascading style sheets allow you to apply some advanced formatting styles to to the image within the documentation, instead of embedding it directly in
an HTML document. More importantly, they allow you to change the formatting the text. If an image is going to be included in the text of the document
in a single file and effect all pages using the style sheet. Instead of struggling you should specify the image's size in the &lt;img&gt; tag, in order to
to produce a specific format in HTML it's often easier and more flexible to allow the user's browser to optimize the formatting of the text before the
specify the formatting in a style sheet.</p> image is loaded.</p>
<h4><a name="boost-style-sheet"></a>Boost Style Sheet</h4>
<p>The concept of using cascading style sheets to format HTML is such a good idea <h3><a name="non-breaking-spaces" id="non-breaking-spaces"></a>Non-breaking
that it can be beneficial to apply this across the entire Boost site. Of course Spaces</h3>
we can't require this (if Boost were to require such trivia for submissions
it's likely that many programmers would be discouraged from contributing). However, <p>Non-breaking spaces (&amp;nbsp;) should be avoided in HTML text.
a &quot;standard&quot; Boost style sheet (http://www.boost.org/boost.css) is Generally there are more appropriate ways to format the document, such as
supplied anyway, so that a contributer can quickly and easily produce clear using list constructs or specifying indentation as a style attribute or in
and consistent documentation that reflects a Boost &quot;brand&quot; if they cascading style sheets.</p>
so choose. If, at a later date, it's decided to update the Boost &quot;brand&quot;,
it may be done in this single file and all documents using the style sheet will <h3><a name="style-sheets" id="style-sheets"></a>Cascading Style
automatically be updated.</p> Sheets</h3>
<p>The Boost supplied style sheet not only specifies styles for many standard
tags, it also specifies several style &quot;classes&quot;. A class is specified <p>Cascading style sheets allow you to apply some advanced formatting
for a given tag instead of being applied to all instances of a given tag type. styles to an HTML document. More importantly, they allow you to change the
Below is a list of the classes specified in the Boost style sheet and a description formatting in a single file and effect all pages using the style sheet.
of when to use them:</p> Instead of struggling to produce a specific format in HTML it's often
<dl> easier and more flexible to specify the formatting in a style sheet.</p>
<dt><b>index</b> Used for &lt;dl&gt; tags when writing index lists.</dt>
<dt><b>page-index</b> Used for &lt;dl&gt; tags when writing page index lists.</dt> <h4><a name="boost-style-sheet" id="boost-style-sheet"></a>Boost Style
<dt><b>Footnote</b> Used when writing Footnote numbers.</dt> Sheet</h4>
<dt><b>function-semantics</b> Used for &lt;dl&gt; tags when writing function
semantic lists.</dt> <p>The concept of using cascading style sheets to format HTML is such a
</dl> good idea that it can be beneficial to apply this across the entire Boost
<h2><a name="templates"></a>Templates</h2> site. Of course we can't require this (if Boost were to require such trivia
<p>Instead of hand coding every HTML page, HTML "templates" can be used instead. for submissions it's likely that many programmers would be discouraged from
The list below provides links to templates that may be used when writing documentation contributing). However, a "standard" Boost style sheet
for a contribution to Boost. Links provided in these templates assume the files (http://www.boost.org/boost.css) is supplied anyway, so that a contributer
will reside in the &quot;traditional&quot; directory hierarchy of <i>boost/libs/library/doc</i>. can quickly and easily produce clear and consistent documentation that
They may need correcting if the file will reside in some other location.</p> reflects a Boost "brand" if they so choose. If, at a later date, it's
<p><b>Note:</b> Since these &quot;templates&quot; are just HTML pages simply clicking decided to update the Boost "brand", it may be done in this single file and
on the links below will load the template in your browser. You will need to all documents using the style sheet will automatically be updated.</p>
use a browser specific method to download the files instead of loading them
into the browser (for instance, on most Windows browsers you can right click <p>The Boost supplied style sheet not only specifies styles for many
on the link and select the appropriate command from the context sensitive menu).</p> standard tags, it also specifies several style "classes". A class is
<ul> specified for a given tag instead of being applied to all instances of a
<li><a name="index-template"></a><a href="template/index.html">Index Page Template</a></li> given tag type. Below is a list of the classes specified in the Boost style
<li><a name="overview-template"></a><a href="template/overview.html">Overview sheet and a description of when to use them:</p>
Page Template</a></li>
<li><a name="definitions-template"></a><a href="template/definitions.html">Definitions <dl>
Page Template</a></li> <dt><b>index</b> Used for &lt;dl&gt; tags when writing index lists.</dt>
<li><a name="rationale-template"></a><a href="template/rationale.html">Rationale
Page Template</a></li> <dt><b>page-index</b> Used for &lt;dl&gt; tags when writing page index
<li><a name="configuration-template"></a><a href="template/configuration.html">Configuration lists.</dt>
Page Template</a></li>
<li><a name="faq-template"></a><a href="template/faq.html">FAQ (Frequently Asked <dt><b>Footnote</b> Used when writing Footnote numbers.</dt>
Questions) Page Template</a></li>
<li><a name="bibliography-template"></a><a href="template/bibliography.html">Bibliography <dt><b>function-semantics</b> Used for &lt;dl&gt; tags when writing
Page Template</a></li> function semantic lists.</dt>
<li><a name="acknowledgements-template"></a><a href="template/acknowledgments.html">Acknowledgments </dl>
Page Template</a></li>
<li><a name="header-template"></a><a href="template/header.html">Header Page <h2><a name="templates" id="templates"></a>Templates</h2>
<p>Instead of hand coding every HTML page, HTML "templates" can be used
instead. The list below provides links to templates that may be used when
writing documentation for a contribution to Boost. Links provided in these
templates assume the files will reside in the "traditional" directory
hierarchy of <i>boost/libs/library/doc</i>. They may need correcting if the
file will reside in some other location.</p>
<p><b>Note:</b> Since these "templates" are just HTML pages simply clicking
on the links below will load the template in your browser. You will need to
use a browser specific method to download the files instead of loading them
into the browser (for instance, on most Windows browsers you can right
click on the link and select the appropriate command from the context
sensitive menu).</p>
<ul>
<li><a name="index-template" id="index-template"></a><a href=
"template/index.html">Index Page Template</a></li>
<li><a name="overview-template" id="overview-template"></a><a href=
"template/overview.html">Overview Page Template</a></li>
<li><a name="definitions-template" id="definitions-template"></a><a href=
"template/definitions.html">Definitions Page Template</a></li>
<li><a name="rationale-template" id="rationale-template"></a><a href=
"template/rationale.html">Rationale Page Template</a></li>
<li><a name="configuration-template" id=
"configuration-template"></a><a href=
"template/configuration.html">Configuration Page Template</a></li>
<li><a name="faq-template" id="faq-template"></a><a href=
"template/faq.html">FAQ (Frequently Asked Questions) Page
Template</a></li> Template</a></li>
</ul>
<hr> <li><a name="bibliography-template" id=
<p>Revised "bibliography-template"></a><a href=
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 November, 2003<!--webbot bot="Timestamp" endspan i-checksum="39371" --> "template/bibliography.html">Bibliography Page Template</a></li>
</p>
<p><i>&copy; Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a> <li><a name="acknowledgements-template" id=
2001. All Rights Reserved.</i></p> "acknowledgements-template"></a><a href=
"template/acknowledgments.html">Acknowledgments Page Template</a></li>
<li><a name="header-template" id="header-template"></a><a href=
"template/header.html">Header Page Template</a></li>
</ul>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2001 <a href=
"mailto:williamkempf@hotmail.com">William E. Kempf</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

83
writingdoc/index.html
View File

@ -1,36 +1,57 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Writing Documentation for Boost</title> <link rel="stylesheet" type="text/css" href="../../boost.css">
<title>Writing Documentation for Boost</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../boost.png" border="0"></a></h3>
<h1 align="center">Writing Documentation for Boost</h1> </td>
<h2 align="center">Index</h2>
</td> <td valign="top">
</tr> <h1 align="center">Writing Documentation for Boost</h1>
</table>
<hr> <h2 align="center">Index</h2>
<h2>Contents</h2> </td>
<dl class="index"> </tr>
<dt><a href="introduction.html">Introduction</a></dt> </table>
<dt><a href="structure.html">Documentation Structure</a></dt> <hr>
<dt><a href="design.html">HTML Design</a></dt>
</dl> <h2>Contents</h2>
<hr>
<p>Revised <dl class="index">
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <dt><a href="introduction.html">Introduction</a></dt>
05 November, 2001
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <dt><a href="structure.html">Documentation Structure</a></dt>
</p>
<p><i>&copy; Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a> <dt><a href="design.html">HTML Design</a></dt>
2001. All Rights Reserved.</i></p> </dl>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2001 <a href=
"mailto:williamkempf@hotmail.com">William E. Kempf</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

106
writingdoc/introduction.html
View File

@ -1,46 +1,68 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Writing Documentation for Boost - Introduction</title> <link rel="stylesheet" type="text/css" href="../../boost.css">
<title>Writing Documentation for Boost - Introduction</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="index.html"><img height="86" width="277" alt="C++ Boost" src="../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost"
<td valign="top"> src="../../boost.png" border="0"></a></h3>
<h1 align="center">Writing Documentation for Boost</h1> </td>
<h2 align="center">Introduction</h2>
</td> <td valign="top">
</tr> <h1 align="center">Writing Documentation for Boost</h1>
</table>
<hr> <h2 align="center">Introduction</h2>
<p>Boost does not have any requirements on how you write your documentation. If </td>
you are submitting a library that already has written documentation in HTML </tr>
format, there is no reason to change it to follow any of the guidelines presented </table>
here. However, if you have documentation that's not in HTML format and can't <hr>
be easily converted to HTML, or if you're starting on a library from scratch
or have a library with no documentation then these guidelines can make writing <p>Boost does not have any requirements on how you write your
the documentation much easier.</p> documentation. If you are submitting a library that already has written
<p>The section on <a href="structure.html">Documentation Structure</a> describes documentation in HTML format, there is no reason to change it to follow any
how to go about structuring the documentation's content. This section may be of the guidelines presented here. However, if you have documentation that's
helpful even for libraries that already have documentation. If there's a desire not in HTML format and can't be easily converted to HTML, or if you're
to present the library for possible inclusion by the C++ Standards Committee starting on a library from scratch or have a library with no documentation
then there may be a need to restructure the documentation's content in order then these guidelines can make writing the documentation much easier.</p>
to insure the content meets explicit requirements for library components (Section
17.3).</p> <p>The section on <a href="structure.html">Documentation Structure</a>
<p>The section on <a href="design.html">HTML Design</a> gives general rules to describes how to go about structuring the documentation's content. This
follow when writing HTML documentation in order to give a professional and consistent section may be helpful even for libraries that already have documentation.
look. This section also contains some template files that can be used to rapidly If there's a desire to present the library for possible inclusion by the
create documentation pages.</p> C++ Standards Committee then there may be a need to restructure the
<hr> documentation's content in order to insure the content meets explicit
<p>Revised requirements for library components (Section 17.3).</p>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 November, 2003<!--webbot bot="Timestamp" endspan i-checksum="39371" -->
</p> <p>The section on <a href="design.html">HTML Design</a> gives general rules
<p><i>&copy; Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a> to follow when writing HTML documentation in order to give a professional
2001. All Rights Reserved.</i></p> and consistent look. This section also contains some template files that
can be used to rapidly create documentation pages.</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2001 <a href=
"mailto:williamkempf@hotmail.com">William E. Kempf</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

657
writingdoc/structure.html
View File

@ -1,254 +1,433 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>Writing Documentation for Boost - Documentation Structure</title> <link rel="stylesheet" type="text/css" href="../../boost.css">
<title>Writing Documentation for Boost - Documentation Structure</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="index.html"><img height="86" width="277" alt="C++ Boost" src="../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="index.html"><img height="86" width="277" alt="C++ Boost"
<td valign="top"> src="../../boost.png" border="0"></a></h3>
<h1 align="center">Writing Documentation for Boost</h1> </td>
<h2 align="center">Documentation Structure</h2>
</td> <td valign="top">
</tr> <h1 align="center">Writing Documentation for Boost</h1>
</table>
<hr> <h2 align="center">Documentation Structure</h2>
<dl class="page-index"> </td>
<dt><a href="#introduction">Introduction</a></dt> </tr>
<dt><a href="#standards-conforming">Standards Conforming Documentation</a></dt> </table>
<hr>
<dl class="page-index"> <dl class="page-index">
<dt><a href="#elements">Document elements</a></dt> <dt><a href="#introduction">Introduction</a></dt>
<dl class="page-index">
<dt><a href="#summary">Summary</a></dt> <dt><a href="#standards-conforming">Standards Conforming
<dt><a href="#requirements">Requirements</a></dt> Documentation</a></dt>
<dt><a href="#detailed-specs">Detailed specifications</a></dt>
<dt><a href="#ref-cpp">References to the Standard C++ library</a></dt> <dd>
<dt><a href="#ref-c">References to the Standard C library</a></dt> <dl class="page-index">
</dl> <dt><a href="#elements">Document elements</a></dt>
<dt><a href="#other">Other conventions</a></dt>
<dl class="page-index"> <dd>
<dt><a href="#type-descs">Type descriptions</a></dt> <dl class="page-index">
</dl> <dt><a href="#summary">Summary</a></dt>
<dt><a href="#requirements">Requirements</a></dt>
<dt><a href="#detailed-specs">Detailed specifications</a></dt>
<dt><a href="#ref-cpp">References to the Standard C++
library</a></dt>
<dt><a href="#ref-c">References to the Standard C
library</a></dt>
</dl>
</dd>
<dt><a href="#other">Other conventions</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#type-descs">Type descriptions</a></dt>
</dl>
</dd>
</dl>
</dd>
<dt><a href="#more">More Information</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#function-semantic-explanations">Function semantic
element explanations</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#requires">Requires</a></dt>
<dt><a href="#effects">Effects</a></dt>
<dt><a href="#postconditions">Postconditions</a></dt>
<dt><a href="#returns">Returns</a></dt>
<dt><a href="#throws">Throws</a></dt>
<dt><a href="#complexity">Complexity</a></dt>
<dt><a href="#rationale">Rationale</a></dt>
</dl>
</dd>
</dl>
</dd>
<dt><a href="#footnotes">Footnotes</a></dt>
</dl> </dl>
<dt><a href="#more">More Information</a></dt>
<dl class="page-index"> <h2><a name="introduction" id="introduction">Introduction</a></h2>
<dt><a href="#function-semantic-explanations">Function semantic element explanations</a></dt>
<dl class="page-index"> <p>Boost itself does not require any specific documentation structure. The
<dt><a href="#requires">Requires</a></dt> C++ Standard, however, has very explicit requirements for the description
<dt><a href="#effects">Effects</a></dt> of library components (Section 17.3). So for Boost libraries likely to be
<dt><a href="#postconditions">Postconditions</a></dt> proposed for inclusion in the standard, it is highly desirable to structure
<dt><a href="#returns">Returns</a></dt> documentation in a way that meets the requirements of the the standard.
<dt><a href="#throws">Throws</a></dt> Doing so eliminates the need to rewrite the documentation for
<dt><a href="#complexity">Complexity</a></dt> standardization.</p>
<dt><a href="#rationale">Rationale</a></dt>
</dl> <p>Library developers should remember that for a library to be accepted as
</dl> part of the C++ Standard Library, the proposal must include full wording.
<dt><a href="#footnotes">Footnotes</a></dt> The committee will not do that work for you.</p>
</dl>
<h2><a name="introduction">Introduction</a></h2> <p>Beyond that, the documentation structure required for the standard is an
<p>Boost itself does not require any specific documentation structure. The C++ effective way to communicate the technical specifications for a library.
Standard, however, has very explicit requirements for the description of library Although terse, it is already familiar to many Boost users, and is far more
components (Section 17.3). So for Boost libraries likely to be proposed for precise than most ad hoc documentation structures.</p>
inclusion in the standard, it is highly desirable to structure documentation
in a way that meets the requirements of the the standard. Doing so eliminates <p>The following description is for the structure of documentation required
the need to rewrite the documentation for standardization.</p> by the standard. Boost libraries should also provided additional
<p>Library developers should remember that for a library to be accepted as part documentation, such as introductory, tutorial, example, and rationale
of the C++ Standard Library, the proposal must include full wording. The committee material.</p>
will not do that work for you.</p>
<p>Beyond that, the documentation structure required for the standard is an effective <h2><a name="standards-conforming" id="standards-conforming">Standards
way to communicate the technical specifications for a library. Although terse, Conforming</a> Documentation</h2>
it is already familiar to many Boost users, and is far more precise than most
ad hoc documentation structures.</p> <h3><a name="elements" id="elements">Document elements</a></h3>
<p>The following description is for the structure of documentation required by
the standard. Boost libraries should also provided additional documentation, <p>Each document contains the following elements, as applicable<a class=
such as introductory, tutorial, example, and rationale material.</p> "footnote" href="#footnote1">(1)</a>:</p>
<h2><a name="standards-conforming">Standards Conforming</a> Documentation</h2>
<h3><a name="elements">Document elements</a></h3> <ul>
<p>Each document contains the following elements, as applicable<a class="footnote" href="#footnote1">(1)</a>:</p> <li><a href="#summary">Summary</a></li>
<ul>
<li><a href="#summary">Summary</a></li> <li><a href="#requirements">Requirements</a></li>
<li><a href="#requirements">Requirements</a></li>
<li><a href="#detailed-specs">Detailed specifications</a></li> <li><a href="#detailed-specs">Detailed specifications</a></li>
<li><a href="#ref-cpp">References to the Standard C++ library</a></li>
<li><a href="#ref-c">References to the Standard C library</a></li> <li><a href="#ref-cpp">References to the Standard C++ library</a></li>
</ul>
<h4><a name="summary">Summary</a></h4> <li><a href="#ref-c">References to the Standard C library</a></li>
<p>The Summary provides a synopsis of the category, and introduces the first-level </ul>
subclauses. Each subclause also provides a summary, listing the headers specified
in the subclause and the library entities provided in each header.</p> <h4><a name="summary" id="summary">Summary</a></h4>
<p>Paragraphs labeled "Note(s):" or "Example(s):" are informative, other paragraphs
are normative.</p> <p>The Summary provides a synopsis of the category, and introduces the
<p>The summary and the detailed specifications are presented in the order:</p> first-level subclauses. Each subclause also provides a summary, listing the
<ul> headers specified in the subclause and the library entities provided in
<li>Macros</li> each header.</p>
<li>Values</li>
<li>Types</li> <p>Paragraphs labeled "Note(s):" or "Example(s):" are informative, other
<li>Classes</li> paragraphs are normative.</p>
<li>Functions</li>
<li>Objects</li> <p>The summary and the detailed specifications are presented in the
</ul> order:</p>
<h4><a name="requirements">Requirements</a></h4>
<p>The library can be extended by a C++ program. Each clause, as applicable, describes <ul>
the requirements that such extensions must meet. Such extensions are generally <li>Macros</li>
one of the following:</p>
<ul> <li>Values</li>
<li>Template arguments</li>
<li>Derived classes</li> <li>Types</li>
<li>Containers, iterators, and/or algorithms that meet an interface convention</li>
</ul> <li>Classes</li>
<p>Interface convention requirements are stated as generally as possible. Instead
of stating "<code>class X</code> has to define a member function <code>operator++()</code>," <li>Functions</li>
the interface requires "for any object <code>x</code> of <code>class X</code>,
<code>++x</code> is defined." That is, whether the operator is a member is unspecified.</p> <li>Objects</li>
<p>Requirements are stated in terms of well-defined expressions, which define </ul>
valid terms of the types that satisfy the requirements. For every set of requirements
there is a table that specifies an initial set of the valid expressions and <h4><a name="requirements" id="requirements">Requirements</a></h4>
their semantics. Any generic algorithm that uses the requirements is described
in terms of the valid expressions for its formal type parameters.</p> <p>The library can be extended by a C++ program. Each clause, as
<p>Template argument requirements are sometimes referenced by name.</p> applicable, describes the requirements that such extensions must meet. Such
<p>In some cases the semantic requirements are presented as C++ code. Such code extensions are generally one of the following:</p>
is intended as a specification of equivalance of a construct to another construct,
not necessarily as the way the construct must be implemented.<a class="footnote" href="#footnote2">(2)</a></p> <ul>
<h4><a name="detailed-specs">Detailed specification</a></h4> <li>Template arguments</li>
<p>The detailed specifications each contain the following elements:</p>
<ul> <li>Derived classes</li>
<li>Name and brief description</li>
<li>Synopsis (class definition or function prototype, as appropriate)</li> <li>Containers, iterators, and/or algorithms that meet an interface
<li>Restrictions on template arguments, if any</li> convention</li>
<li>Description of class invariants</li> </ul>
<li>Description of function semantics</li>
</ul> <p>Interface convention requirements are stated as generally as possible.
<p>Descriptions of class member functions follow the order (as appropriate)<a class="footnote" href="#footnote3">(3)</a>:</p> Instead of stating "<code>class X</code> has to define a member function
<ul> <code>operator++()</code>," the interface requires "for any object
<li>Constructor(s) and destructor</li> <code>x</code> of <code>class X</code>, <code>++x</code> is defined." That
<li>Copying and assignment functions</li> is, whether the operator is a member is unspecified.</p>
<li>Comparison functions</li>
<li>Modifier functions</li> <p>Requirements are stated in terms of well-defined expressions, which
<li>Observer functions</li> define valid terms of the types that satisfy the requirements. For every
<li>Operators and other non-member functions</li> set of requirements there is a table that specifies an initial set of the
</ul> valid expressions and their semantics. Any generic algorithm that uses the
<p>Descriptions of function semantics contain the following <a name="function-elements">elements</a> requirements is described in terms of the valid expressions for its formal
(as appropriate)<a class="footnote" href="#footnote4">(4):</a></p> type parameters.</p>
<dl class="function-semantics">
<dt><b><a href="#requires">Requires:</a></b> the preconditions for calling the <p>Template argument requirements are sometimes referenced by name.</p>
<p>In some cases the semantic requirements are presented as C++ code. Such
code is intended as a specification of equivalance of a construct to
another construct, not necessarily as the way the construct must be
implemented.<a class="footnote" href="#footnote2">(2)</a></p>
<h4><a name="detailed-specs" id="detailed-specs">Detailed
specification</a></h4>
<p>The detailed specifications each contain the following elements:</p>
<ul>
<li>Name and brief description</li>
<li>Synopsis (class definition or function prototype, as
appropriate)</li>
<li>Restrictions on template arguments, if any</li>
<li>Description of class invariants</li>
<li>Description of function semantics</li>
</ul>
<p>Descriptions of class member functions follow the order (as
appropriate)<a class="footnote" href="#footnote3">(3)</a>:</p>
<ul>
<li>Constructor(s) and destructor</li>
<li>Copying and assignment functions</li>
<li>Comparison functions</li>
<li>Modifier functions</li>
<li>Observer functions</li>
<li>Operators and other non-member functions</li>
</ul>
<p>Descriptions of function semantics contain the following <a name=
"function-elements" id="function-elements">elements</a> (as
appropriate)<a class="footnote" href="#footnote4">(4):</a></p>
<dl class="function-semantics">
<dt><b><a href="#requires">Requires:</a></b> the preconditions for
calling the function</dt>
<dt><b><a href="#effects">Effects:</a></b> the actions performed by the
function</dt> function</dt>
<dt><b><a href="#effects">Effects:</a></b> the actions performed by the function</dt>
<dt><b><a href="#postconditions">Postconditions:</a></b> the observable results <dt><b><a href="#postconditions">Postconditions:</a></b> the observable
established by the function</dt> results established by the function</dt>
<dt><b><a href="#returns">Returns:</a></b> a description of the value(s) returned
by the function</dt> <dt><b><a href="#returns">Returns:</a></b> a description of the value(s)
<dt><b><a href="#throws">Throws:</a></b> any exceptions thrown by the function, returned by the function</dt>
and the conditions that would cause the exception</dt>
<dt><b><a href="#complexity">Complexity:</a></b> the time and/or space complexity <dt><b><a href="#throws">Throws:</a></b> any exceptions thrown by the
of the function</dt> function, and the conditions that would cause the exception</dt>
<dt><b><a href="#rationale">Rationale:</a></b> the rationale for the function's design
or existence</dt> <dt><b><a href="#complexity">Complexity:</a></b> the time and/or space
</dl> complexity of the function</dt>
<p>Complexity requirements specified in the library clauses are upper bounds,
and implementations that provide better complexity guarantees satisfy the requirements.</p> <dt><b><a href="#rationale">Rationale:</a></b> the rationale for the
<h4><a name="ref-cpp">References to the C++ Standard library</a></h4> function's design or existence</dt>
<h4><a name="ref-c">References to the C Standard library</a></h4> </dl>
<h3><a name="other">Other conventions</a></h3>
<p>These conventions are for describing implementation-defined types, and member <p>Complexity requirements specified in the library clauses are upper
functions.</p> bounds, and implementations that provide better complexity guarantees
<h4><a name="type-descs">Type descriptions</a></h4> satisfy the requirements.</p>
<p>The Requirements subclauses may describe names that are used to specify constraints
on template arguments.</p> <h4><a name="ref-cpp" id="ref-cpp">References to the C++ Standard
<h2><a name="more">More Information</a></h2> library</a></h4>
<h3><a name="function-semantic-explanations">Function semantic element explanations</a></h3>
<p>The function semantic element description <a href="#function-elements">above</a> <h4><a name="ref-c" id="ref-c">References to the C Standard
is taken directly from the C++ standard, and is quite terse. Here is a more library</a></h4>
detailed explanation of each of the elements.</p>
<p>Note the use of the <code>&lt;code&gt; ... &lt;/code&gt;</code> font tag to <h3><a name="other" id="other">Other conventions</a></h3>
distinguish actual C++ usage from English prose.</p>
<h4><a name="requires">Requires</a></h4> <p>These conventions are for describing implementation-defined types, and
<p>Preconditions for calling the function, typically expressed as predicates. member functions.</p>
The most common preconditions are requirements on the value of arguments, often
in the form of C++ expressions. For example, <h4><a name="type-descs" id="type-descs">Type descriptions</a></h4>
<pre>
<p>The Requirements subclauses may describe names that are used to specify
constraints on template arguments.</p>
<h2><a name="more" id="more">More Information</a></h2>
<h3><a name="function-semantic-explanations" id=
"function-semantic-explanations">Function semantic element
explanations</a></h3>
<p>The function semantic element description <a href=
"#function-elements">above</a> is taken directly from the C++ standard, and
is quite terse. Here is a more detailed explanation of each of the
elements.</p>
<p>Note the use of the <code>&lt;code&gt; ... &lt;/code&gt;</code> font tag
to distinguish actual C++ usage from English prose.</p>
<h4><a name="requires" id="requires">Requires</a></h4>
<p>Preconditions for calling the function, typically expressed as
predicates. The most common preconditions are requirements on the value of
arguments, often in the form of C++ expressions. For example,</p>
<pre>
<code>void limit( int * p, int min, int max );</code> <code>void limit( int * p, int min, int max );</code>
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> <code>p != 0 &amp;&amp; min &lt;= max</code></dt> <dl class="function-semantics">
</dl> <dt><b>Requires:</b> <code>p != 0 &amp;&amp; min &lt;= max</code></dt>
<p>Requirements already enforced by the C++ language rules (such as the type of </dl>
arguments) are not repeated in Requires paragraphs.</p>
<h4><a name="effects">Effects</a></h4> <p>Requirements already enforced by the C++ language rules (such as the
<p>The actions performed by the function, described either in prose or in C++. type of arguments) are not repeated in Requires paragraphs.</p>
A description in prose is often less limiting on implementors, but is often
less precise than C++ code.</p> <h4><a name="effects" id="effects">Effects</a></h4>
<p>If an effect is specified in one of the other elements, particularly <i>postconditions</i>,
<i>returns</i>, or <i>throws</i>, it is not also described in the <i>effects</i> <p>The actions performed by the function, described either in prose or in
paragraph. Having only a single description ensures that there is one and only C++. A description in prose is often less limiting on implementors, but is
one specification, and thus eliminates the risk of divergence.</p> often less precise than C++ code.</p>
<h4><a name="postconditions">Postconditions</a></h4>
<p>The observable results of the function, such as the value of variables. Postconditions <p>If an effect is specified in one of the other elements, particularly
are often expressed as predicates that are true after the function completes, <i>postconditions</i>, <i>returns</i>, or <i>throws</i>, it is not also
in the form of C++ expressions. For example:</p> described in the <i>effects</i> paragraph. Having only a single description
<pre> ensures that there is one and only one specification, and thus eliminates
the risk of divergence.</p>
<h4><a name="postconditions" id="postconditions">Postconditions</a></h4>
<p>The observable results of the function, such as the value of variables.
Postconditions are often expressed as predicates that are true after the
function completes, in the form of C++ expressions. For example:</p>
<pre>
void make_zero_if_negative( int &amp; x ); void make_zero_if_negative( int &amp; x );
</pre> </pre>
<dl class="function-semantics">
<dt><b>Postcondition:</b> <code>x &gt;= 0</code></dt> <dl class="function-semantics">
</dl> <dt><b>Postcondition:</b> <code>x &gt;= 0</code></dt>
<h4><a name="returns">Returns</a></h4> </dl>
<p>The value returned by the function, usually in the form of a C++ expression.
For example:</p> <h4><a name="returns" id="returns">Returns</a></h4>
<pre>int sum( int x, int y );
<p>The value returned by the function, usually in the form of a C++
expression. For example:</p>
<pre>
int sum( int x, int y );
</pre> </pre>
<dl class="function-semantics">
<dt><b>Returns:</b> <code>x + y</code></dt> <dl class="function-semantics">
</dl> <dt><b>Returns:</b> <code>x + y</code></dt>
<p>Only specify the return value; the type is already dictated by C++ language </dl>
rules.
<h4><a name="throws">Throws</a></h4> <p>Only specify the return value; the type is already dictated by C++
<p>Specify both the type of exception thrown, and the condition that causes the language rules.</p>
exception to be thrown. For example, the <code>std::basic_string</code> class
specifies: <h4><a name="throws" id="throws">Throws</a></h4>
<pre>
<p>Specify both the type of exception thrown, and the condition that causes
the exception to be thrown. For example, the <code>std::basic_string</code>
class specifies:</p>
<pre>
void resize(size_type n, charT c); void resize(size_type n, charT c);
</pre> </pre>
<dl class="function-semantics">
<dt><b>Throws:</b> <code> length_error</code> if <code>n &gt; max_size()</code>.</dt> <dl class="function-semantics">
</dl> <dt><b>Throws:</b> <code>length_error</code> if <code>n &gt;
<h4><a name="complexity">Complexity</a></h4> max_size()</code>.</dt>
<p>Specifying the time and/or space complexity of a function is often not desirable </dl>
because it over-constrains implementors and is hard to specify correctly. Complexity
is thus often best left as a quality of implementation issue.</p> <h4><a name="complexity" id="complexity">Complexity</a></h4>
<p>A library component, however, can become effectively non-portable if there
is wide variation in performance between conforming implementations. Containers <p>Specifying the time and/or space complexity of a function is often not
are a prime example. In these cases it becomes worthwhile to specify complexity.</p> desirable because it over-constrains implementors and is hard to specify
<p>Complexity is often specified in generalized <a href="http://hissa.nist.gov/dads/HTML/bigOnotation.html"> correctly. Complexity is thus often best left as a quality of
&quot;Big-O&quot; notation</a>.</p> implementation issue.</p>
<h4><a name="rationale">Rationale</a></h4>
<p>Specifying the rationale for a function's design or existence can often give users <p>A library component, however, can become effectively non-portable if
a lot of insight into why a library is designed the way it is. More importantly, it there is wide variation in performance between conforming implementations.
can help prevent "fixing" something that wasn't really broken as the library matures.</p> Containers are a prime example. In these cases it becomes worthwhile to
<h2><a name="footnotes">Footnotes</a></h2> specify complexity.</p>
<dl>
<dt><a class="footnote" name="footnote1">(1)</a> <p>Complexity is often specified in generalized <a href=
To save space, items that do not apply to a clause are omitted. For example, "http://hissa.nist.gov/dads/HTML/bigOnotation.html">"Big-O"
if a clause does not specify any requirements, there will be no "Requirements" notation</a>.</p>
<h4><a name="rationale" id="rationale">Rationale</a></h4>
<p>Specifying the rationale for a function's design or existence can often
give users a lot of insight into why a library is designed the way it is.
More importantly, it can help prevent "fixing" something that wasn't really
broken as the library matures.</p>
<h2><a name="footnotes" id="footnotes">Footnotes</a></h2>
<dl>
<dt><a class="footnote" name="footnote1" id="footnote1">(1)</a> To save
space, items that do not apply to a clause are omitted. For example, if a
clause does not specify any requirements, there will be no "Requirements"
subclause.</dt> subclause.</dt>
<dt><a class="footnote" name="footnote2">(2)</a> Although in some cases the
code is unambiguously the optimum implementation.</dt> <dt><a class="footnote" name="footnote2" id="footnote2">(2)</a> Although
<dt><a class="footnote" name="footnote3">(3)</a> To save space, items that do in some cases the code is unambiguously the optimum implementation.</dt>
not apply to a class are omitted. For example, if a class does not specify
any comparison functions, there will be no "Comparison functions" subclause.</dt> <dt><a class="footnote" name="footnote3" id="footnote3">(3)</a> To save
<dt><a class="footnote" name="footnote4">(4)</a> To save space, items that do space, items that do not apply to a class are omitted. For example, if a
not apply to a function are omitted. For example, if a function does not specify class does not specify any comparison functions, there will be no
any precondition, there will be no "Requires" paragraph.</dt> "Comparison functions" subclause.</dt>
</dl>
<hr> <dt><a class="footnote" name="footnote4" id="footnote4">(4)</a> To save
<p>Revised space, items that do not apply to a function are omitted. For example, if
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->29 November, 2003<!--webbot bot="Timestamp" endspan i-checksum="39371" --> a function does not specify any precondition, there will be no "Requires"
</p> paragraph.</dt>
<p><i>&copy; Copyright <a href="mailto:williamkempf@hotmail.com">William E. Kempf</a> </dl>
2001. All Rights Reserved.</i></p> <hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2001 <a href=
"mailto:williamkempf@hotmail.com">William E. Kempf</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

69
writingdoc/template/acknowledgments.html
View File

@ -1,31 +1,48 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Acknowledgments</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Acknowledgments</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Acknowledgments</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Acknowledgments</h2>
{{text}} </td>
<hr> </tr>
<p>Revised </table>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <hr>
05 November, 2001 {{text}}
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <hr>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
2002. All Rights Reserved.</i></p> "http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

69
writingdoc/template/bibliography.html
View File

@ -1,31 +1,48 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Bibliography</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Bibliography</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Bibliography</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Bibliography</h2>
{{bibliographical information}} </td>
<hr> </tr>
<p>Revised </table>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <hr>
05 November, 2001 {{bibliographical information}}
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <hr>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
2002. All Rights Reserved.</i></p> "http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

225
writingdoc/template/configuration.html
View File

@ -1,90 +1,145 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Configuration</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Configuration</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Configuration</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Configuration</h2>
<dl class="page-index"> </td>
<dt><a href="#introduction">Introduction</a></dt> </tr>
<dt><a href="#app-defined">Application Defined Macros</a></dt> </table>
<dt><a href="#lib-defined-public">Public Library Defined Macros</a></dt> <hr>
<dt><a href="#lib-defined-impl">Library Defined Implementation Macros</a></dt>
</dl> <dl class="page-index">
<h2><a name="introduction"></a>Introduction</h2> <dt><a href="#introduction">Introduction</a></dt>
<p>{{library}} uses several configuration macros in <a href="http://www.boost.org/libs/config/config.htm">&lt;boost/config.hpp&gt;</a>,
as well as configuration macros meant to be supplied by the application. These <dt><a href="#app-defined">Application Defined Macros</a></dt>
macros are documented here.</p>
<h2><a name="app-defined"></a>Application Defined Macros</h2> <dt><a href="#lib-defined-public">Public Library Defined Macros</a></dt>
<p>These are the macros that may be defined by an application using {{library}}.</p>
<table summary="application defined macros" cellspacing="10" width="100%"> <dt><a href="#lib-defined-impl">Library Defined Implementation
<tr> Macros</a></dt>
<td><b>Macro</b></td> </dl>
<td><b>Meaning</b></td>
</tr> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
<tr>
<td>{{macro}}</td> <p>{{library}} uses several configuration macros in <a href=
<td>{{meaning}}</td> "http://www.boost.org/libs/config/config.htm">&lt;boost/config.hpp&gt;</a>,
</tr> as well as configuration macros meant to be supplied by the application.
<tr> These macros are documented here.</p>
<td>{{macro}}</td>
<td>{{meaning}}</td> <h2><a name="app-defined" id="app-defined"></a>Application Defined
</tr> Macros</h2>
</table>
<h2><a name="lib-defined-public"></a>Public Library Defined Macros</h2> <p>These are the macros that may be defined by an application using
<p>These macros are defined by {{library}} but are expected to be used by application {{library}}.</p>
code.</p>
<table summary="public library defined macros" cellspacing="10" width="100%"> <table summary="application defined macros" cellspacing="10" width="100%">
<tr> <tr>
<td><b>Macro</b></td> <td><b>Macro</b></td>
<td><b>Meaning</b></td>
</tr> <td><b>Meaning</b></td>
<tr> </tr>
<td>{{macro}}</td>
<td>{{meaning}}</td> <tr>
</tr> <td>{{macro}}</td>
<tr>
<td>{{macro}}</td> <td>{{meaning}}</td>
<td>{{meaning}}</td> </tr>
</tr>
</table> <tr>
<h2><a name="lib-defined-impl"></a>Library Defined Implementation Macros</h2> <td>{{macro}}</td>
<p>These macros are defined by {{library}} and are implementation details of interest
only to implementers.</p> <td>{{meaning}}</td>
<table summary="library defined implementation macros" cellspacing="10" width="100%"> </tr>
<tr> </table>
<td><b>Macro</b></td>
<td><b>Meaning</b></td> <h2><a name="lib-defined-public" id="lib-defined-public"></a>Public Library
</tr> Defined Macros</h2>
<tr>
<td>{{macro}}</td> <p>These macros are defined by {{library}} but are expected to be used by
<td>{{meaning}}</td> application code.</p>
</tr>
<tr> <table summary="public library defined macros" cellspacing="10" width=
<td>{{macro}}</td> "100%">
<td>{{meaning}}</td> <tr>
</tr> <td><b>Macro</b></td>
</table>
<hr> <td><b>Meaning</b></td>
<p>Revised </tr>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
05 November, 2001 <tr>
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <td>{{macro}}</td>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <td>{{meaning}}</td>
2002. All Rights Reserved.</i></p> </tr>
<tr>
<td>{{macro}}</td>
<td>{{meaning}}</td>
</tr>
</table>
<h2><a name="lib-defined-impl" id="lib-defined-impl"></a>Library Defined
Implementation Macros</h2>
<p>These macros are defined by {{library}} and are implementation details
of interest only to implementers.</p>
<table summary="library defined implementation macros" cellspacing="10"
width="100%">
<tr>
<td><b>Macro</b></td>
<td><b>Meaning</b></td>
</tr>
<tr>
<td>{{macro}}</td>
<td>{{meaning}}</td>
</tr>
<tr>
<td>{{macro}}</td>
<td>{{meaning}}</td>
</tr>
</table>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

111
writingdoc/template/definitions.html
View File

@ -1,47 +1,78 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Definitions</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Definitions</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Definitions</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Definitions</h2>
<h2>Contents</h2> </td>
<dl class="page-index"> </tr>
<dt><a href="#introduction">Introduction</a></dt> </table>
<dt><a href="#definitions">Definitions</a></dt> <hr>
<h2>Contents</h2>
<dl class="page-index"> <dl class="page-index">
<dt><a href="#definition-term1">Term 1</a></dt> <dt><a href="#introduction">Introduction</a></dt>
<dt><a href="#definition-term2">Term 2</a></dt>
<dt><a href="#definitions">Definitions</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#definition-term1">Term 1</a></dt>
<dt><a href="#definition-term2">Term 2</a></dt>
</dl>
</dd>
</dl> </dl>
</dl> <hr>
<hr>
<h2><a name="introduction"></a>Introduction</h2> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
<p>{{Introductory text}}</p>
<h2><a name="definitions"></a>Definitions</h2> <p>{{Introductory text}}</p>
<dl class="definitions">
<dt><a name="definition-term1"></a><b>{{term}}:</b> {{definition}}</dt> <h2><a name="definitions" id="definitions"></a>Definitions</h2>
<dt><a name="definition-term2"></a><b>{{term}}:</b> {{definition}}</dt>
</dl> <dl class="definitions">
<hr> <dt><a name="definition-term1" id="definition-term1"></a><b>{{term}}:</b>
<p>Revised {{definition}}</dt>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
05 November, 2001 <dt><a name="definition-term2" id="definition-term2"></a><b>{{term}}:</b>
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> {{definition}}</dt>
</p> </dl>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <hr>
2002. All Rights Reserved.</i></p>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

89
writingdoc/template/faq.html
View File

@ -1,38 +1,61 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - FAQ</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - FAQ</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Frequently Asked Questions (FAQs)</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Frequently Asked Questions (FAQs)</h2>
<dl class="page-index"> </td>
<dt><a href="#question1">{{question}}</a></dt> </tr>
<dt><a href="#question2">{{question}}</a></dt> </table>
</dl> <hr>
<h2><a name="question1"></a>{{question}}</h2>
<p>{{answer}}</p> <dl class="page-index">
<h2><a name="question2"></a>{{question}}</h2> <dt><a href="#question1">{{question}}</a></dt>
<p>{{answer}}</p>
<hr> <dt><a href="#question2">{{question}}</a></dt>
<p>Revised </dl>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
05 November, 2001 <h2><a name="question1" id="question1"></a>{{question}}</h2>
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
</p> <p>{{answer}}</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a>
2002. All Rights Reserved.</i></p> <h2><a name="question2" id="question2"></a>{{question}}</h2>
<p>{{answer}}</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

491
writingdoc/template/header.html
View File

@ -1,195 +1,346 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{library}} - Header &lt;{{header}}&gt;</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{library}} - Header &lt;{{header}}&gt;</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{library}}</h1> </td>
<h2 align="center">Header &lt;{{header}}&gt;</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{library}}</h1>
</table>
<hr> <h2 align="center">Header &lt;{{header}}&gt;</h2>
<h2>Contents</h2> </td>
<dl class="page-index"> </tr>
<dt><a href="#introduction">Introduction</a></dt> </table>
<dt><a href="#macros">Macros</a></dt> <hr>
<h2>Contents</h2>
<dl class="page-index"> <dl class="page-index">
<dt><a href="#macro-spec">{{macro name}}</a></dt> <dt><a href="#introduction">Introduction</a></dt>
<dt><a href="#macros">Macros</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#macro-spec">{{macro name}}</a></dt>
</dl>
</dd>
<dt><a href="#values">Values</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#value-spec">{{value name}}</a></dt>
</dl>
</dd>
<dt><a href="#types">Types</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#type-spec">{{type name}}</a></dt>
</dl>
</dd>
<dt><a href="#classes">Classes</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#class-spec">Class <code>{{class name}}</code></a></dt>
<dd>
<dl class="page-index">
<dt><a href="#class-spec-synopsis">Class <code>{{class
name}}</code> synopsis</a></dt>
<dt><a href="#class-spec-ctors">Class <code>{{class name}}</code>
constructors and destructor</a></dt>
<dt><a href="#class-spec-comparisons">Class <code>{{class
name}}</code> comparison functions</a></dt>
<dt><a href="#class-spec-modifiers">Class <code>{{class
name}}</code> modifier functions</a></dt>
<dt><a href="#class-spec-observers">Class <code>{{class
name}}</code> observer functions</a></dt>
<dt><a href="#class-spec-statics">Class <code>{{class
name}}</code> static functions</a></dt>
</dl>
</dd>
</dl>
</dd>
<dt><a href="#functions">Functions</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#function-spec">{{function name}}</a></dt>
</dl>
</dd>
<dt><a href="#objects">Objects</a></dt>
<dd>
<dl class="page-index">
<dt><a href="#object-spec">{{object name}}</a></dt>
</dl>
</dd>
<dt><a href="#examples">Example(s)</a></dt>
</dl> </dl>
<dt><a href="#values">Values</a></dt> <hr>
<dl class="page-index">
<dt><a href="#value-spec">{{value name}}</a></dt> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
</dl>
<dt><a href="#types">Types</a></dt> <p>{{Introductory text}}</p>
<dl class="page-index">
<dt><a href="#type-spec">{{type name}}</a></dt> <h2><a name="macros" id="macros"></a>Macros</h2>
</dl>
<dt><a href="#classes">Classes</a></dt> <p><a name="macro-spec" id="macro-spec"></a>{{Macro specifications}}</p>
<dl class="page-index">
<dt><a href="#class-spec">Class <code>{{class name}}</code></a></dt> <h2><a name="values" id="values"></a>Values</h2>
<dl class="page-index">
<dt><a href="#class-spec-synopsis">Class <code>{{class name}}</code> synopsis</a></dt> <p><a name="value-spec" id="value-spec"></a>{{Value specifications}}</p>
<dt><a href="#class-spec-ctors">Class <code>{{class name}}</code> constructors and destructor</a></dt>
<dt><a href="#class-spec-comparisons">Class <code>{{class name}}</code> comparison functions</a></dt> <h2><a name="types" id="types"></a>Types</h2>
<dt><a href="#class-spec-modifiers">Class <code>{{class name}}</code> modifier functions</a></dt>
<dt><a href="#class-spec-observers">Class <code>{{class name}}</code> observer functions</a></dt> <p><a name="type-spec" id="type-spec"></a>{{Type specifications}}</p>
<dt><a href="#class-spec-statics">Class <code>{{class name}}</code> static functions</a></dt>
</dl> <h2><a name="classes" id="classes"></a>Classes</h2>
</dl>
<dt><a href="#functions">Functions</a></dt> <h3><a name="class-spec" id="class-spec"></a>Class <code>{{class
<dl class="page-index"> name}}</code></h3>
<dt><a href="#function-spec">{{function name}}</a></dt>
</dl> <p>{{class overview text}}</p>
<dt><a href="#objects">Objects</a></dt>
<dl class="page-index"> <h4><a name="class-spec-synopsis" id="class-spec-synopsis"></a>Class
<dt><a href="#object-spec">{{object name}}</a></dt> <code>{{class name}}</code> synopsis</h4>
</dl> <pre>
<dt><a href="#examples">Example(s)</a></dt>
</dl>
<hr>
<h2><a name="introduction"></a>Introduction</h2>
<p>{{Introductory text}}</p>
<h2><a name="macros"></a>Macros</h2>
<p><a name="macro-spec"></a>{{Macro specifications}}</p>
<h2><a name="values"></a>Values</h2>
<p><a name="value-spec"></a>{{Value specifications}}</p>
<h2><a name="types"></a>Types</h2>
<p><a name="type-spec"></a>{{Type specifications}}</p>
<h2><a name="classes"></a>Classes</h2>
<h3><a name="class-spec"></a>Class <code>{{class name}}</code></h3>
<p>{{class overview text}}</p>
<h4><a name="class-spec-synopsis"></a>Class <code>{{class name}}</code> synopsis</h4>
<pre>
namespace boost namespace boost
{ {
class {{class name}} class {{class name}}
{ {
}; };
}; };
</pre> </pre>
<h4><a name="class-spec-ctors"></a>Class <code>{{class name}}</code> constructors and destructor</h4>
<pre> <h4><a name="class-spec-ctors" id="class-spec-ctors"></a>Class
<code>{{class name}}</code> constructors and destructor</h4>
<pre>
{{constructor}} {{constructor}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<pre>
<dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<pre>
{{destructor}} {{destructor}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h4><a name="class-spec-comparisons"></a>Class <code>{{class name}}</code> comparison functions</h4>
<pre> <dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-comparisons" id="class-spec-comparisons"></a>Class
<code>{{class name}}</code> comparison functions</h4>
<pre>
{{function}} {{function}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h4><a name="class-spec-modifiers"></a>Class <code>{{class name}}</code> modifier functions</h4>
<pre> <dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-modifiers" id="class-spec-modifiers"></a>Class
<code>{{class name}}</code> modifier functions</h4>
<pre>
{{function}} {{function}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h4><a name="class-spec-observers"></a>Class <code>{{class name}}</code> observer functions</h4>
<pre> <dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-observers" id="class-spec-observers"></a>Class
<code>{{class name}}</code> observer functions</h4>
<pre>
{{function}} {{function}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h4><a name="class-spec-statics"></a>Class <code>{{class name}}</code> static functions</h4>
<pre> <dt><b>Complexity:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<h4><a name="class-spec-statics" id="class-spec-statics"></a>Class
<code>{{class name}}</code> static functions</h4>
<pre>
{{function}} {{function}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h2><a name="functions"></a>Functions</h2>
<pre> <dt><b>Complexity:</b> {{text}}</dt>
<a name="function-spec"></a>{{function}}
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl>
<h2><a name="functions" id="functions"></a>Functions</h2>
<pre>
<a name="function-spec" id="function-spec"></a>{{function}}
</pre> </pre>
<dl class="function-semantics">
<dt><b>Requires:</b> {{text}}</dt> <dl class="function-semantics">
<dt><b>Effects:</b> {{text}}</dt> <dt><b>Requires:</b> {{text}}</dt>
<dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Returns:</b> {{text}}</dt> <dt><b>Effects:</b> {{text}}</dt>
<dt><b>Throws:</b> {{text}}</dt>
<dt><b>Complexity:</b> {{text}}</dt> <dt><b>Postconditions:</b> {{text}}</dt>
<dt><b>Note:</b> {{text}}</dt>
<dt><b>Danger:</b> {{text}}</dt> <dt><b>Returns:</b> {{text}}</dt>
<dt><b>Rationale:</b> {{text}}</dt>
</dl> <dt><b>Throws:</b> {{text}}</dt>
<h2><a name="objects"></a>Objects</h2>
<p><a name="object-spec"></a>{{Object specifications}}</p> <dt><b>Complexity:</b> {{text}}</dt>
<h2><a name="examples"></a>Example(s)</h2>
<p>{{Example(s)}}</p> <dt><b>Note:</b> {{text}}</dt>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <dt><b>Danger:</b> {{text}}</dt>
05 November, 2001
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <dt><b>Rationale:</b> {{text}}</dt>
</p> </dl>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a>
2002. All Rights Reserved.</i></p> <h2><a name="objects" id="objects"></a>Objects</h2>
<p><a name="object-spec" id="object-spec"></a>{{Object specifications}}</p>
<h2><a name="examples" id="examples"></a>Example(s)</h2>
<p>{{Example(s)}}</p>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

182
writingdoc/template/index.html
View File

@ -1,70 +1,126 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}}</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}}</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Index</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Index</h2>
<h2>Contents</h2> </td>
<dl class="index"> </tr>
<dt><a href="overview.html">Overview</a></dt> </table>
<dt>Reference</dt> <hr>
<h2>Contents</h2>
<dl class="index"> <dl class="index">
<dt><a href="header.html">{{header}}</a></dt> <dt><a href="overview.html">Overview</a></dt>
<dl class="index">
<dt><a href="header.html#macros">Macros</a></dt> <dt>Reference</dt>
<dl class="index">
<dt><a href="header.html#macro-spec">{{macro name}}</a></dt> <dd>
</dl> <dl class="index">
<dt><a href="header.html#values">Values</a></dt> <dt><a href="header.html">{{header}}</a></dt>
<dl class="index">
<dt><a href="header.html#value-spec">{{value name}}</a></dt> <dd>
</dl> <dl class="index">
<dt><a href="header.html#types">Types</a></dt> <dt><a href="header.html#macros">Macros</a></dt>
<dl class="index">
<dt><a href="header.html#value-spec">{{type name}}</a></dt> <dd>
</dl> <dl class="index">
<dt><a href="header.html#classes">Classes</a></dt> <dt><a href="header.html#macro-spec">{{macro name}}</a></dt>
<dl class="index"> </dl>
<dt><a href="header.html#value-spec">{{class name}}</a></dt> </dd>
</dl>
<dt><a href="header.html#functions">Functions</a></dt> <dt><a href="header.html#values">Values</a></dt>
<dl class="index">
<dt><a href="header.html#value-spec">{{function name}}</a></dt> <dd>
</dl> <dl class="index">
<dt><a href="header.html#objects">Objects</a></dt> <dt><a href="header.html#value-spec">{{value name}}</a></dt>
<dl class="index"> </dl>
<dt><a href="header.html#value-spec">{{object name}}</a></dt> </dd>
</dl>
</dl> <dt><a href="header.html#types">Types</a></dt>
<dd>
<dl class="index">
<dt><a href="header.html#value-spec">{{type name}}</a></dt>
</dl>
</dd>
<dt><a href="header.html#classes">Classes</a></dt>
<dd>
<dl class="index">
<dt><a href="header.html#value-spec">{{class name}}</a></dt>
</dl>
</dd>
<dt><a href="header.html#functions">Functions</a></dt>
<dd>
<dl class="index">
<dt><a href="header.html#value-spec">{{function
name}}</a></dt>
</dl>
</dd>
<dt><a href="header.html#objects">Objects</a></dt>
<dd>
<dl class="index">
<dt><a href="header.html#value-spec">{{object name}}</a></dt>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><a href="configuration.html">Configuration Information</a></dt>
<dt><a href="rationale.html">Rationale</a></dt>
<dt><a href="definitions.html">Definitions</a></dt>
<dt><a href="faq.html">Frequently Asked Questions (FAQs)</a></dt>
<dt><a href="bibliography.html">Bibliography</a></dt>
<dt><a href="acknowledgments.html">Acknowledgments</a></dt>
</dl> </dl>
<dt><a href="configuration.html">Configuration Information</a></dt> <hr>
<dt><a href="rationale.html">Rationale</a></dt>
<dt><a href="definitions.html">Definitions</a></dt> <p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
<dt><a href="faq.html">Frequently Asked Questions (FAQs)</a></dt> "http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
<dt><a href="bibliography.html">Bibliography</a></dt> height="31" width="88"></a></p>
<dt><a href="acknowledgments.html">Acknowledgments</a></dt>
</dl> <p>Revised
<hr> <!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
<p>Revised December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
05 November, 2001 <p><i>Copyright &copy; 2006 <a href=
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> "mailto:{{address}}">{{author}}</a></i></p>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <p><i>Distributed under the Boost Software License, Version 1.0. (See
2002. All Rights Reserved.</i></p> accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

116
writingdoc/template/overview.html
View File

@ -1,47 +1,79 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Overview</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Overview</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Overview</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Overview</h2>
<dl class="index"> </td>
<dt><a href="#introduction">Introduction</a></dt> </tr>
<dt><a href="#topic1">First topic</a></dt> </table>
<dt><a href="#topic2">Second topic</a></dt> <hr>
<dt><a href="#footnotes">Footnotes</a></dt>
</dl> <dl class="index">
<h2><a name="introduction"></a>Introduction</h2> <dt><a href="#introduction">Introduction</a></dt>
<p>{{text}}</p>
<h2><a name="topic1"></a>First Topic</h2> <dt><a href="#topic1">First topic</a></dt>
<p>{{text}}</p>
<h2><a name="topic2"></a>Second Topic</h2> <dt><a href="#topic2">Second topic</a></dt>
<p>{{text}}</p>
<h2><a name="footnotes"></a>Footnotes</h2> <dt><a href="#footnotes">Footnotes</a></dt>
<dl> </dl>
<dt><a name="footnote1" class="footnote">(1)</a> {{text}}</dt>
<dt><a name="footnote2" class="footnote">(2)</a> {{text}}</dt> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
</dl>
<hr> <p>{{text}}</p>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <h2><a name="topic1" id="topic1"></a>First Topic</h2>
05 November, 2001
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <p>{{text}}</p>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <h2><a name="topic2" id="topic2"></a>Second Topic</h2>
2002. All Rights Reserved.</i></p>
<p>{{text}}</p>
<h2><a name="footnotes" id="footnotes"></a>Footnotes</h2>
<dl>
<dt><a name="footnote1" class="footnote" id="footnote1">(1)</a>
{{text}}</dt>
<dt><a name="footnote2" class="footnote" id="footnote2">(2)</a>
{{text}}</dt>
</dl>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>

116
writingdoc/template/rationale.html
View File

@ -1,47 +1,79 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta http-equiv="Content-Language" content="en-us">
<link rel="stylesheet" type="text/css" href="../../../boost.css"> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<title>{{Library}} - Rationale</title> <link rel="stylesheet" type="text/css" href="../../../boost.css">
<title>{{Library}} - Rationale</title>
</head> </head>
<body link="#0000ff" vlink="#800080">
<table border="0" cellpadding="7" cellspacing="0" width="100%" summary= <body link="#0000FF" vlink="#800080">
"header"> <table border="0" cellpadding="7" cellspacing="0" width="100%" summary=
<tr> "header">
<td valign="top" width="300"> <tr>
<h3><a href="../../../index.htm"><img height="86" width="277" alt="C++ Boost" src="../../../boost.png" border="0"></a></h3> <td valign="top" width="300">
</td> <h3><a href="../../../index.htm"><img height="86" width="277" alt=
<td valign="top"> "C++ Boost" src="../../../boost.png" border="0"></a></h3>
<h1 align="center">{{Library}}</h1> </td>
<h2 align="center">Rationale</h2>
</td> <td valign="top">
</tr> <h1 align="center">{{Library}}</h1>
</table>
<hr> <h2 align="center">Rationale</h2>
<dl class="index"> </td>
<dt><a href="#introduction">Introduction</a></dt> </tr>
<dt><a href="#topic1">First topic</a></dt> </table>
<dt><a href="#topic2">Second topic</a></dt> <hr>
<dt><a href="#footnotes">Footnotes</a></dt>
</dl> <dl class="index">
<h2><a name="introduction"></a>Introduction</h2> <dt><a href="#introduction">Introduction</a></dt>
<p>{{text}}</p>
<h2><a name="topic1"></a>First Topic</h2> <dt><a href="#topic1">First topic</a></dt>
<p>{{text}}</p>
<h2><a name="topic2"></a>Second Topic</h2> <dt><a href="#topic2">Second topic</a></dt>
<p>{{text}}</p>
<h2><a name="footnotes"></a>Footnotes</h2> <dt><a href="#footnotes">Footnotes</a></dt>
<dl> </dl>
<dt><a name="footnote1" class="footnote">(1)</a> {{text}}</dt>
<dt><a name="footnote2" class="footnote">(2)</a> {{text}}</dt> <h2><a name="introduction" id="introduction"></a>Introduction</h2>
</dl>
<hr> <p>{{text}}</p>
<p>Revised
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan --> <h2><a name="topic1" id="topic1"></a>First Topic</h2>
05 November, 2001
<!--webbot bot="Timestamp" endspan i-checksum="39359" --> <p>{{text}}</p>
</p>
<p><i>&copy; Copyright <a href="mailto:{{address}}">{{author}}</a> <h2><a name="topic2" id="topic2"></a>Second Topic</h2>
2002. All Rights Reserved.</i></p>
<p>{{text}}</p>
<h2><a name="footnotes" id="footnotes"></a>Footnotes</h2>
<dl>
<dt><a name="footnote1" class="footnote" id="footnote1">(1)</a>
{{text}}</dt>
<dt><a name="footnote2" class="footnote" id="footnote2">(2)</a>
{{text}}</dt>
</dl>
<hr>
<p><a href="http://validator.w3.org/check?uri=referer"><img border="0" src=
"http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan -->04
December, 2006<!--webbot bot="Timestamp" endspan i-checksum="38514" --></p>
<p><i>Copyright &copy; 2006 <a href=
"mailto:{{address}}">{{author}}</a></i></p>
<p><i>Distributed under the Boost Software License, Version 1.0. (See
accompanying file <a href="../../../LICENSE_1_0.txt">LICENSE_1_0.txt</a> or
copy at <a href=
"http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</a>)</i></p>
</body> </body>
</html> </html>