diff options
Diffstat (limited to 'doc/html/boostbook/dtd')
72 files changed, 6829 insertions, 0 deletions
diff --git a/doc/html/boostbook/dtd/boostbook.html b/doc/html/boostbook/dtd/boostbook.html new file mode 100644 index 0000000000..2fe0dadbc5 --- /dev/null +++ b/doc/html/boostbook/dtd/boostbook.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element boostbook</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="library-reference.html" title=" + BoostBook element library-reference"> +<link rel="next" href="union.html" title=" + BoostBook element union"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library-reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="union.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.boostbook"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">boostbook</code></span></h2> +<p>boostbook — Defines a BoostBook book</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">boostbook ::= + (title, (chapter| <a href="library.html" title=" + BoostBook element library">library</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1676330"></a><h2>Description</h2> +<p>This element is the topmost level defined by + <code class="filename">boost.xml</code> for all Boost documentation. It will + not generally be used by developers.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1676343"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library-reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="union.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/class-specialization.html b/doc/html/boostbook/dtd/class-specialization.html new file mode 100644 index 0000000000..429917b9c4 --- /dev/null +++ b/doc/html/boostbook/dtd/class-specialization.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element class-specialization</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="next" href="link-test.html" title=" + BoostBook element link-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="link-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.class-specialization"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">class-specialization</code></span></h2> +<p>class-specialization — A specialization (partial or full) of a class template</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">class-specialization ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="specialization.html" title=" + BoostBook element specialization">specialization</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>?, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1675056"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../reference.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="link-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/class.html b/doc/html/boostbook/dtd/class.html new file mode 100644 index 0000000000..191720990c --- /dev/null +++ b/doc/html/boostbook/dtd/class.html @@ -0,0 +1,156 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element class</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="overloaded-function.html" title=" + BoostBook element overloaded-function"> +<link rel="next" href="librarycategorydef.html" title=" + BoostBook element librarycategorydef"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-function.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorydef.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.class"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">class</code></span></h2> +<p>class — Declares a class or class template</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">class ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1698397"></a><h2>Description</h2> +<p>C++ classes and class templates are described via the + <class> element. Each class has a name (e.g., "any") given by + the <code class="computeroutput">name</code> attribute, a purpose given by the + <purpose> element, documentation, and a set of types, + functions, base classes, and data members. Here is a minimal + definition of the <code class="computeroutput"><a href="../../boost/any.html" title="Class any">boost::any</a></code> class:</p> +<pre class="programlisting"><namespace name="boost"> + <class name="any"> + <purpose> + A class whose instances can hold instances of any type that satisfies + ValueType requirements. + </purpose> + </class> +</namespace></pre> +<p>Additional class documentation can be contained in a + <code class="sgmltag-element">description</code> element following the <purpose> + element. This documentation will be typeset prior to documentation + for specific elements in the class (e.g., constructors or + methods).</p> +<p>Class inheritance is described via the <inherit> + element. The <inherit> element requires an <code class="computeroutput">access</code> + attribute which must be one of <span class="emphasis"><em>public</em></span>, + <span class="emphasis"><em>protected</em></span>, or <span class="emphasis"><em>private</em></span>. The + content of the <inherited> element in C++ code that names the + class inherited, and may contain markup to link to the class. The + following description of the class + <code class="computeroutput"><a href="../../bad_any_cast.html" title="Class bad_any_cast">boost::bad_any_cast</a></code> describes public + inheritance from the class <code class="computeroutput">std::bad_cast</code>. It + also defines the <purpose> element, which contains a short + description of the use of the class.</p> +<pre class="programlisting"><class name="bad_any_cast"> + <inherit access="public"><classname>std::bad_cast</classname></inherit> + <purpose><para>The exception thrown in the event of a failed + <functionname>any_cast</functionname> of an + <classname>any</classname> value.</para></purpose> +</class></pre> +<p>Class templates are defined by <class> elements with a + <template> child element at the beginning.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1698524"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-function.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorydef.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/code.html b/doc/html/boostbook/dtd/code.html new file mode 100644 index 0000000000..1a0359f787 --- /dev/null +++ b/doc/html/boostbook/dtd/code.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element code</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="static-constant.html" title=" + BoostBook element static-constant"> +<link rel="next" href="destructor.html" title=" + BoostBook element destructor"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static-constant.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="destructor.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.code"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">code</code></span></h2> +<p>code — Mimics the <code class="sgmltag-element">code</code> tag in HTML</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">code ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1675584"></a><h2>Description</h2> +<p>Text within a <code class="sgmltag-element">code</code> tag is generally typeset + in a different, monospaced font so that it stands out as code. The + <code class="sgmltag-element">code</code> tag in BoostBook is transformed directly + into the <code class="sgmltag-element">computeroutput</code> tag in DocBook.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1675603"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static-constant.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="destructor.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/compile-fail-test.html b/doc/html/boostbook/dtd/compile-fail-test.html new file mode 100644 index 0000000000..7df22301d5 --- /dev/null +++ b/doc/html/boostbook/dtd/compile-fail-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element compile-fail-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="template.html" title=" + BoostBook element template"> +<link rel="next" href="returns.html" title=" + BoostBook element returns"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="returns.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.compile-fail-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">compile-fail-test</code></span></h2> +<p>compile-fail-test — A testcase that should fail to compile</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">compile-fail-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1697619"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="returns.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/compile-test.html b/doc/html/boostbook/dtd/compile-test.html new file mode 100644 index 0000000000..2b4a474a21 --- /dev/null +++ b/doc/html/boostbook/dtd/compile-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element compile-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="postconditions.html" title=" + BoostBook element postconditions"> +<link rel="next" href="method.html" title=" + BoostBook element method"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="postconditions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="method.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.compile-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">compile-test</code></span></h2> +<p>compile-test — A testcase that should compile correctly</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">compile-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1677279"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="postconditions.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="method.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/complexity.html b/doc/html/boostbook/dtd/complexity.html new file mode 100644 index 0000000000..60b8b473db --- /dev/null +++ b/doc/html/boostbook/dtd/complexity.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element complexity</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="programlisting.html" title=" + BoostBook element programlisting"> +<link rel="next" href="purpose.html" title=" + BoostBook element purpose"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="programlisting.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="purpose.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.complexity"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">complexity</code></span></h2> +<p>complexity — The time/space/etc. complexity of a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">complexity ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1699132"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="programlisting.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="purpose.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/constructor.html b/doc/html/boostbook/dtd/constructor.html new file mode 100644 index 0000000000..5e7fb5d504 --- /dev/null +++ b/doc/html/boostbook/dtd/constructor.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element constructor</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="snippet.html" title=" + BoostBook element snippet"> +<link rel="next" href="namespace.html" title=" + BoostBook element namespace"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="snippet.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="namespace.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.constructor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">constructor</code></span></h2> +<p>constructor — Declares a constructor of the enclosing class</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">constructor ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1677714"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1695206"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="snippet.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="namespace.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/copy-assignment.html b/doc/html/boostbook/dtd/copy-assignment.html new file mode 100644 index 0000000000..bf8a724aa1 --- /dev/null +++ b/doc/html/boostbook/dtd/copy-assignment.html @@ -0,0 +1,121 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element copy-assignment</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarypurpose.html" title=" + BoostBook element librarypurpose"> +<link rel="next" href="run-fail-test.html" title=" + BoostBook element run-fail-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarypurpose.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="run-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.copy-assignment"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">copy-assignment</code></span></h2> +<p>copy-assignment — Declares a copy-assignment operator</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">copy-assignment ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="type.html" title=" + BoostBook element type">type</a>?, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1697259"></a><h2>Description</h2> +<p>The return type of the copy-assignment operator does not need + to be specified. If left unspecified, it will default to an + unqualified reference to the enclosing class type.</p> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1697280"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>cv</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>cv-qualifiers for this method, e.g., const volatile</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarypurpose.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="run-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/data-member.html b/doc/html/boostbook/dtd/data-member.html new file mode 100644 index 0000000000..5db84ed83c --- /dev/null +++ b/doc/html/boostbook/dtd/data-member.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element data-member</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="notes.html" title=" + BoostBook element notes"> +<link rel="next" href="specialization.html" title=" + BoostBook element specialization"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notes.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.data-member"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">data-member</code></span></h2> +<p>data-member — Declares a data member of a class</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">data-member ::= + (<a href="type.html" title=" + BoostBook element type">type</a>, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1695943"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notes.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/default.html b/doc/html/boostbook/dtd/default.html new file mode 100644 index 0000000000..f5739a3e2f --- /dev/null +++ b/doc/html/boostbook/dtd/default.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element default</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="returns.html" title=" + BoostBook element returns"> +<link rel="next" href="parameter.html" title=" + BoostBook element parameter"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="returns.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.default"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">default</code></span></h2> +<p>default — The default value of a function or template parameter</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">default ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1697762"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="returns.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/description.html b/doc/html/boostbook/dtd/description.html new file mode 100644 index 0000000000..64b602ea1a --- /dev/null +++ b/doc/html/boostbook/dtd/description.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element description</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="template-type-parameter.html" title=" + BoostBook element template-type-parameter"> +<link rel="next" href="librarylist.html" title=" + BoostBook element librarylist"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-type-parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarylist.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.description"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">description</code></span></h2> +<p>description — Detailed description of a construct</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">description ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1675962"></a><h2>Description</h2> +<p>Although the context model for this element is + <code class="computeroutput">ANY</code>, detailed descriptions should contain structured + DocBook elements that occur within sections, e.g., paragraphs + (<code class="sgmltag-element">para</code>, <code class="sgmltag-element">simpara</code>), lists + (<code class="sgmltag-element">orderedlist</code>, <code class="sgmltag-element">itemizedlist</code>), + tables (<code class="sgmltag-element">informaltable</code>, <code class="sgmltag-element">table</code>), + etc.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1675998"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-type-parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarylist.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/destructor.html b/doc/html/boostbook/dtd/destructor.html new file mode 100644 index 0000000000..4e5a255f96 --- /dev/null +++ b/doc/html/boostbook/dtd/destructor.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element destructor</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="code.html" title=" + BoostBook element code"> +<link rel="next" href="template-type-parameter.html" title=" + BoostBook element template-type-parameter"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="code.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-type-parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.destructor"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">destructor</code></span></h2> +<p>destructor — Declares a destructor for the enclosing class</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">destructor ::= + (<a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675753"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1675768"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="code.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-type-parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/effects.html b/doc/html/boostbook/dtd/effects.html new file mode 100644 index 0000000000..863a51f8b8 --- /dev/null +++ b/doc/html/boostbook/dtd/effects.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element effects</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="requires.html" title=" + BoostBook element requires"> +<link rel="next" href="libraryname.html" title=" + BoostBook element libraryname"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requires.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libraryname.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.effects"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">effects</code></span></h2> +<p>effects — Declares the side effects of a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">effects ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1700468"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requires.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libraryname.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/enum.html b/doc/html/boostbook/dtd/enum.html new file mode 100644 index 0000000000..d6e0199aa5 --- /dev/null +++ b/doc/html/boostbook/dtd/enum.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element enum</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="lib.html" title=" + BoostBook element lib"> +<link rel="next" href="requires.html" title=" + BoostBook element requires"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lib.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="requires.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.enum"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">enum</code></span></h2> +<p>enum — Declares an enumeration type</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">enum ::= + (<a href="enumvalue.html" title=" + BoostBook element enumvalue">enumvalue</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1700302"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lib.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="requires.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/enumvalue.html b/doc/html/boostbook/dtd/enumvalue.html new file mode 100644 index 0000000000..84481c9bf3 --- /dev/null +++ b/doc/html/boostbook/dtd/enumvalue.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element enumvalue</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="type.html" title=" + BoostBook element type"> +<link rel="next" href="overloaded-method.html" title=" + BoostBook element overloaded-method"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-method.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.enumvalue"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">enumvalue</code></span></h2> +<p>enumvalue — A single value of an enumeration</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">enumvalue ::= + (<a href="default.html" title=" + BoostBook element default">default</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1698805"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-method.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/free-function-group.html b/doc/html/boostbook/dtd/free-function-group.html new file mode 100644 index 0000000000..6456f21c27 --- /dev/null +++ b/doc/html/boostbook/dtd/free-function-group.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element free-function-group</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="if-fails.html" title=" + BoostBook element if-fails"> +<link rel="next" href="functionname.html" title=" + BoostBook element functionname"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="if-fails.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="functionname.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.free-function-group"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">free-function-group</code></span></h2> +<p>free-function-group — A set of functions that are grouped together under one name</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">free-function-group ::= + (<a href="function.html" title=" + BoostBook element function">function</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1695563"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="if-fails.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="functionname.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/function.html b/doc/html/boostbook/dtd/function.html new file mode 100644 index 0000000000..420734d533 --- /dev/null +++ b/doc/html/boostbook/dtd/function.html @@ -0,0 +1,165 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element function</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="source.html" title=" + BoostBook element source"> +<link rel="next" href="postconditions.html" title=" + BoostBook element postconditions"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="postconditions.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.function"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">function</code></span></h2> +<p>function — Declares a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">function ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="type.html" title=" + BoostBook element type">type</a>, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1677021"></a><h2>Description</h2> +<p>BoostBook functions are documented by specifying the + function's interface (e.g., its C++ signature) and its + behavior. Constructors, destructors, member functions, and free + functions all use the same documentation method, although the + top-level tags differ.</p> +<p>The behavior of functions in BoostBook is documenting using a + style similar to that of the C++ standard, with clauses describing + the requirements, effects, postconditions, exception behavior, and + return values of functions.</p> +<p>The following example illustrates some constructors and a + destructor for <code class="computeroutput"><a href="../../boost/any.html" title="Class any">boost::any</a></code>. Note that one of + the constructors takes a single parameter whose name is "other" and + whose type, <code class="computeroutput">const any&</code> is contained in the + <paramtype> element; any number of parameters may be specified + in this way.</p> +<pre class="programlisting"><class name="any"> + <constructor> + <postconditions><para><this->empty()></para></postconditions> + </constructor> + + <constructor> + <parameter name="other"> + <paramtype>const <classname>any</classname>&amp;</paramtype> + </parameter> + + <effects> + <simpara> Copy constructor that copies + content of <code>other</code> into the new instance, + so that any content is equivalent in both type and value to the + content of <code>other</code>, or empty if + <code>other</code> is + empty. + </simpara> + </effects> + + <throws> + <simpara>May fail with a + <classname>std::bad_alloc</classname> exception or any + exceptions arising from the copy constructor of the + contained type. + </simpara> + </throws> + </constructor> + + <destructor> + <effects><simpara>Releases any and all resources used in + management of instance.</simpara></effects> + + <throws><simpara>Nothing.</simpara></throws> + </destructor> +</class></pre> +</div> +<div class="refsection" lang="en"> +<a name="id1677067"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="postconditions.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/functionname.html b/doc/html/boostbook/dtd/functionname.html new file mode 100644 index 0000000000..a00924b5c0 --- /dev/null +++ b/doc/html/boostbook/dtd/functionname.html @@ -0,0 +1,97 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element functionname</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="free-function-group.html" title=" + BoostBook element free-function-group"> +<link rel="next" href="librarycategory.html" title=" + BoostBook element librarycategory"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="free-function-group.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategory.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.functionname"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">functionname</code></span></h2> +<p>functionname — References a function with the given name</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">functionname ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1695650"></a><h2>Description</h2> +<p>If a function (or overloaded function) with the given, + possibly-qualified name is found, this generates a link to that + function. Lookups obey currently-active <a href="using-class.html" title=" + BoostBook element using-class"><code class="sgmltag-element">using-class</code></a> + and <a href="using-namespace.html" title=" + BoostBook element using-namespace"><code class="sgmltag-element">using-namespace</code></a> + directives to aid in the search, along with searching within the + current scope.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1695678"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="free-function-group.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategory.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/header.html b/doc/html/boostbook/dtd/header.html new file mode 100644 index 0000000000..88be079dbc --- /dev/null +++ b/doc/html/boostbook/dtd/header.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element header</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="testsuite.html" title=" + BoostBook element testsuite"> +<link rel="next" href="rationale.html" title=" + BoostBook element rationale"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="testsuite.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.header"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">header</code></span></h2> +<p>header — Declares a C++ header with the given name</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">header ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1700835"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="testsuite.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/if-fails.html b/doc/html/boostbook/dtd/if-fails.html new file mode 100644 index 0000000000..57f8c1ded8 --- /dev/null +++ b/doc/html/boostbook/dtd/if-fails.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element if-fails</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="namespace.html" title=" + BoostBook element namespace"> +<link rel="next" href="free-function-group.html" title=" + BoostBook element free-function-group"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="namespace.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="free-function-group.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.if-fails"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">if-fails</code></span></h2> +<p>if-fails — What it means when a testcase fails</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">if-fails ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1695512"></a><h2>Description</h2> +<p> + Describes to the user the effect a certain failing testcase will + have on the usefulness of a library. This field is useful in cases + where a failed testcase does not mean that the library won't be + useful, but may mean that certain library features will not be + available. + </p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="namespace.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="free-function-group.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/inherit.html b/doc/html/boostbook/dtd/inherit.html new file mode 100644 index 0000000000..3ab73b8468 --- /dev/null +++ b/doc/html/boostbook/dtd/inherit.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element inherit</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="union.html" title=" + BoostBook element union"> +<link rel="next" href="template-varargs.html" title=" + BoostBook element template-varargs"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-varargs.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.inherit"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">inherit</code></span></h2> +<p>inherit — Declares a base class of the enclosing class or struct</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">inherit ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1676678"></a><h2>Description</h2> +<p>This element contains the name of the class inherited. The + content model is free-form, as the inherited class may be an + instantiation of a template and may have markup in it (e.g., + <code class="sgmltag-element">classname</code> tags).</p> +</div> +<div class="refsection" lang="en"> +<a name="id1676691"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>access</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td> </td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-varargs.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/lib.html b/doc/html/boostbook/dtd/lib.html new file mode 100644 index 0000000000..db116c5526 --- /dev/null +++ b/doc/html/boostbook/dtd/lib.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element lib</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="struct.html" title=" + BoostBook element struct"> +<link rel="next" href="enum.html" title=" + BoostBook element enum"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="enum.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.lib"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">lib</code></span></h2> +<p>lib — A library dependency</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">lib ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1700251"></a><h2>Description</h2> +<p>Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile.</p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="enum.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/library-reference.html b/doc/html/boostbook/dtd/library-reference.html new file mode 100644 index 0000000000..5d797c9df5 --- /dev/null +++ b/doc/html/boostbook/dtd/library-reference.html @@ -0,0 +1,113 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element library-reference</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarylist.html" title=" + BoostBook element librarylist"> +<link rel="next" href="boostbook.html" title=" + BoostBook element boostbook"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.library-reference"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">library-reference</code></span></h2> +<p>library-reference — Declares the reference material for a library</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">library-reference ::= + (title?, section*, (<a href="header.html" title=" + BoostBook element header">header</a>| <a href="library-reference.html" title=" + BoostBook element library-reference">library-reference</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1676182"></a><h2>Description</h2> +<p>Reference documentation for a library is contained with a + <library-reference> element. The <library-reference> + element has no attributes, and contains as children only + <header> elements.</p> +<p>The <header> element defines a C++ header file. Within + each C++ header file lie the definitions of C++ constructs to be + documented. The <code class="computeroutput">name</code> attribute of the <header> + element gives the name of the header, as one would specify when + including the header. For instance, the <library-reference> + for the <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> library may look like + this:</p> +<pre class="programlisting"><library-reference> + <header name="boost/any.hpp"> + <!-- C++ constructs in this header --> + </header> +</library-reference></pre> +<p>If the <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> library contained + multiple headers, we would list them all as children of the + <library-reference> element.</p> +<p><code class="sgmltag-element">library-reference</code> elements can be nested, + so that reference material can be divided into separate sections + that each contain different headers.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1676246"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/library.html b/doc/html/boostbook/dtd/library.html new file mode 100644 index 0000000000..6ae09fb277 --- /dev/null +++ b/doc/html/boostbook/dtd/library.html @@ -0,0 +1,113 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element library</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="template-nontype-parameter.html" title=" + BoostBook element template-nontype-parameter"> +<link rel="next" href="librarycategorylist.html" title=" + BoostBook element librarycategorylist"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-nontype-parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorylist.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.library"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">library</code></span></h2> +<p>library — Top-level element for a library</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">library ::= + (<a href="libraryinfo.html" title=" + BoostBook element libraryinfo">libraryinfo</a>, (title, ((section| <a href="library-reference.html" title=" + BoostBook element library-reference">library-reference</a>| <a href="testsuite.html" title=" + BoostBook element testsuite">testsuite</a>))+)?) +</div> +<div class="refsection" lang="en"> +<a name="id1699421"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>dirname</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td> </td> +</tr> +<tr> +<td>url</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td> </td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +<tr> +<td>html-only</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td> </td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-nontype-parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorylist.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/librarycategory.html b/doc/html/boostbook/dtd/librarycategory.html new file mode 100644 index 0000000000..b277475607 --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategory.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element librarycategory</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="functionname.html" title=" + BoostBook element functionname"> +<link rel="next" href="notes.html" title=" + BoostBook element notes"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="functionname.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="notes.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.librarycategory"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">librarycategory</code></span></h2> +<p>librarycategory — Declares that the enclosing library is in this category</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">librarycategory ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1695755"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="functionname.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="notes.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/librarycategorydef.html b/doc/html/boostbook/dtd/librarycategorydef.html new file mode 100644 index 0000000000..a424751ffd --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategorydef.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element librarycategorydef</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="class.html" title=" + BoostBook element class"> +<link rel="next" href="type.html" title=" + BoostBook element type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="type.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.librarycategorydef"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">librarycategorydef</code></span></h2> +<p>librarycategorydef — Defines a new library category</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">librarycategorydef ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1698612"></a><h2>Description</h2> +<p>All library category definitions should be in <code class="filename">doc/src/boost.xml</code>, and the names of categories must be prefixed with "<code class="computeroutput">category:</code>".</p> +</div> +<div class="refsection" lang="en"> +<a name="id1698631"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="type.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/librarycategorylist.html b/doc/html/boostbook/dtd/librarycategorylist.html new file mode 100644 index 0000000000..ed26698903 --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategorylist.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element librarycategorylist</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="library.html" title=" + BoostBook element library"> +<link rel="next" href="using-namespace.html" title=" + BoostBook element using-namespace"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="using-namespace.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.librarycategorylist"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">librarycategorylist</code></span></h2> +<p>librarycategorylist — Categorized listing of libraries</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">librarycategorylist ::= + (<a href="librarycategorydef.html" title=" + BoostBook element librarycategorydef">librarycategorydef</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1699546"></a><h2>Description</h2> +<p>This element is not intended for use by developers, but is + used by <code class="filename">doc/src/boost.xml</code> as a + placeholder.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1699559"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="using-namespace.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/libraryinfo.html b/doc/html/boostbook/dtd/libraryinfo.html new file mode 100644 index 0000000000..834ef2de8b --- /dev/null +++ b/doc/html/boostbook/dtd/libraryinfo.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element libraryinfo</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="libraryname.html" title=" + BoostBook element libraryname"> +<link rel="next" href="testsuite.html" title=" + BoostBook element testsuite"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryname.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="testsuite.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.libraryinfo"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">libraryinfo</code></span></h2> +<p>libraryinfo — Provides information about a library</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">libraryinfo ::= + (author+, copyright*, legalnotice*, <a href="librarypurpose.html" title=" + BoostBook element librarypurpose">librarypurpose</a>, <a href="librarycategory.html" title=" + BoostBook element librarycategory">librarycategory</a>*) +</div> +<div class="refsection" lang="en"> +<a name="id1700638"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryname.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="testsuite.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/librarylist.html b/doc/html/boostbook/dtd/librarylist.html new file mode 100644 index 0000000000..fc7f17a188 --- /dev/null +++ b/doc/html/boostbook/dtd/librarylist.html @@ -0,0 +1,90 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element librarylist</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="description.html" title=" + BoostBook element description"> +<link rel="next" href="library-reference.html" title=" + BoostBook element library-reference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="description.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="library-reference.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.librarylist"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">librarylist</code></span></h2> +<p>librarylist — Placeholder for an alphabetical list of libraries</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">librarylist ::= + EMPTY +</div> +<div class="refsection" lang="en"> +<a name="id1676075"></a><h2>Description</h2> +<p>Developers aren't generally expected to use this element. Its existence is mainly as a placeholder in <code class="filename">boost.xml</code> for the alphabetical list of libraries.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1676089"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="description.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="library-reference.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/libraryname.html b/doc/html/boostbook/dtd/libraryname.html new file mode 100644 index 0000000000..5ee2e27edc --- /dev/null +++ b/doc/html/boostbook/dtd/libraryname.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element libraryname</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="effects.html" title=" + BoostBook element effects"> +<link rel="next" href="libraryinfo.html" title=" + BoostBook element libraryinfo"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="effects.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libraryinfo.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.libraryname"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">libraryname</code></span></h2> +<p>libraryname — References a library of the given name</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">libraryname ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1700545"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="effects.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="libraryinfo.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/librarypurpose.html b/doc/html/boostbook/dtd/librarypurpose.html new file mode 100644 index 0000000000..1992cd7fd3 --- /dev/null +++ b/doc/html/boostbook/dtd/librarypurpose.html @@ -0,0 +1,88 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element librarypurpose</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="run-test.html" title=" + BoostBook element run-test"> +<link rel="next" href="copy-assignment.html" title=" + BoostBook element copy-assignment"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="copy-assignment.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.librarypurpose"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">librarypurpose</code></span></h2> +<p>librarypurpose — Describes in one short sentence or phrase the purpose of a library</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">librarypurpose ::= + (#PCDATA| <a href="code.html" title=" + BoostBook element code">code</a>| ulink| <a href="functionname.html" title=" + BoostBook element functionname">functionname</a>| methodname| classname)* +</div> +<div class="refsection" lang="en"> +<a name="id1697088"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="copy-assignment.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/link-fail-test.html b/doc/html/boostbook/dtd/link-fail-test.html new file mode 100644 index 0000000000..03daf687bc --- /dev/null +++ b/doc/html/boostbook/dtd/link-fail-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element link-fail-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="link-test.html" title=" + BoostBook element link-test"> +<link rel="next" href="typedef.html" title=" + BoostBook element typedef"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="typedef.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.link-fail-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">link-fail-test</code></span></h2> +<p>link-fail-test — Declares a test that should compile but fail to link</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">link-fail-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675282"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="typedef.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/link-test.html b/doc/html/boostbook/dtd/link-test.html new file mode 100644 index 0000000000..4d171bb008 --- /dev/null +++ b/doc/html/boostbook/dtd/link-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element link-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="class-specialization.html" title=" + BoostBook element class-specialization"> +<link rel="next" href="link-fail-test.html" title=" + BoostBook element link-fail-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="link-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.link-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">link-test</code></span></h2> +<p>link-test — Declares a test that should compile and link</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">link-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675180"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="link-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/method-group.html b/doc/html/boostbook/dtd/method-group.html new file mode 100644 index 0000000000..554abf5c51 --- /dev/null +++ b/doc/html/boostbook/dtd/method-group.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element method-group</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="template-arg.html" title=" + BoostBook element template-arg"> +<link rel="next" href="requirement.html" title=" + BoostBook element requirement"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-arg.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="requirement.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.method-group"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">method-group</code></span></h2> +<p>method-group — A set of methods that are grouped together under one name</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">method-group ::= + (<a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1696554"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-arg.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="requirement.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/method.html b/doc/html/boostbook/dtd/method.html new file mode 100644 index 0000000000..940959965a --- /dev/null +++ b/doc/html/boostbook/dtd/method.html @@ -0,0 +1,124 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element method</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="compile-test.html" title=" + BoostBook element compile-test"> +<link rel="next" href="snippet.html" title=" + BoostBook element snippet"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="snippet.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.method"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">method</code></span></h2> +<p>method — Declares a method, i.e., a member function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">method ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="type.html" title=" + BoostBook element type">type</a>, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1677439"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1677454"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>cv</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>cv-qualifiers for this method, e.g., const volatile</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="snippet.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/namespace.html b/doc/html/boostbook/dtd/namespace.html new file mode 100644 index 0000000000..4a02cce0d0 --- /dev/null +++ b/doc/html/boostbook/dtd/namespace.html @@ -0,0 +1,120 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element namespace</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="constructor.html" title=" + BoostBook element constructor"> +<link rel="next" href="if-fails.html" title=" + BoostBook element if-fails"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="constructor.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="if-fails.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.namespace"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">namespace</code></span></h2> +<p>namespace — Declares a namespace</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">namespace ::= + (<a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="namespace.html" title=" + BoostBook element namespace">namespace</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1695385"></a><h2>Description</h2> +<p>BoostBook namespaces are declared via the <namespace> + element. As in C++, namespaces can be nested and contain other C++ + constructs, such as classes or functions. The <code class="computeroutput">name</code> + attribute of a <namespace> element gives the namespace name + (e.g., "boost"). The <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> library is + defined entirely within namespace boost by:</p> +<pre class="programlisting"><library-reference> + <header name="boost/any.hpp"> + <namespace name="boost"> + <!-- C++ constructs in the boost namespace --> + </namespace> + </header> +</library-reference></pre> +</div> +<div class="refsection" lang="en"> +<a name="id1695418"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="constructor.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="if-fails.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/notes.html b/doc/html/boostbook/dtd/notes.html new file mode 100644 index 0000000000..0feff37edd --- /dev/null +++ b/doc/html/boostbook/dtd/notes.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element notes</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarycategory.html" title=" + BoostBook element librarycategory"> +<link rel="next" href="data-member.html" title=" + BoostBook element data-member"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategory.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="data-member.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.notes"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">notes</code></span></h2> +<p>notes — Non-normative notes about a function's semantics</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">notes ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1695844"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategory.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="data-member.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/overloaded-function.html b/doc/html/boostbook/dtd/overloaded-function.html new file mode 100644 index 0000000000..bd51825992 --- /dev/null +++ b/doc/html/boostbook/dtd/overloaded-function.html @@ -0,0 +1,110 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element overloaded-function</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="signature.html" title=" + BoostBook element signature"> +<link rel="next" href="class.html" title=" + BoostBook element class"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="signature.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="class.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.overloaded-function"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">overloaded-function</code></span></h2> +<p>overloaded-function — An overloaded function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">overloaded-function ::= + (<a href="signature.html" title=" + BoostBook element signature">signature</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1698122"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1698137"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="signature.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="class.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/overloaded-method.html b/doc/html/boostbook/dtd/overloaded-method.html new file mode 100644 index 0000000000..638a8b14d5 --- /dev/null +++ b/doc/html/boostbook/dtd/overloaded-method.html @@ -0,0 +1,110 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element overloaded-method</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="enumvalue.html" title=" + BoostBook element enumvalue"> +<link rel="next" href="programlisting.html" title=" + BoostBook element programlisting"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumvalue.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="programlisting.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.overloaded-method"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">overloaded-method</code></span></h2> +<p>overloaded-method — An overloaded method</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">overloaded-method ::= + (<a href="signature.html" title=" + BoostBook element signature">signature</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, <a href="requires.html" title=" + BoostBook element requires">requires</a>?, <a href="effects.html" title=" + BoostBook element effects">effects</a>?, <a href="postconditions.html" title=" + BoostBook element postconditions">postconditions</a>?, <a href="returns.html" title=" + BoostBook element returns">returns</a>?, <a href="throws.html" title=" + BoostBook element throws">throws</a>?, <a href="complexity.html" title=" + BoostBook element complexity">complexity</a>?, <a href="notes.html" title=" + BoostBook element notes">notes</a>?, <a href="rationale.html" title=" + BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1698973"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a href="function.html" title=" + BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1698988"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumvalue.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="programlisting.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/parameter.html b/doc/html/boostbook/dtd/parameter.html new file mode 100644 index 0000000000..d388c625e5 --- /dev/null +++ b/doc/html/boostbook/dtd/parameter.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element parameter</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="default.html" title=" + BoostBook element default"> +<link rel="next" href="signature.html" title=" + BoostBook element signature"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="default.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="signature.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.parameter"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">parameter</code></span></h2> +<p>parameter — A function parameter</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">parameter ::= + (<a href="paramtype.html" title=" + BoostBook element paramtype">paramtype</a>, <a href="default.html" title=" + BoostBook element default">default</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1697854"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody><tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="default.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="signature.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/paramtype.html b/doc/html/boostbook/dtd/paramtype.html new file mode 100644 index 0000000000..37b52a3382 --- /dev/null +++ b/doc/html/boostbook/dtd/paramtype.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element paramtype</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="precondition.html" title=" + BoostBook element precondition"> +<link rel="next" href="using-class.html" title=" + BoostBook element using-class"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="precondition.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="using-class.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.paramtype"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">paramtype</code></span></h2> +<p>paramtype — The type of a function parameter</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">paramtype ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1696803"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="precondition.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="using-class.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/postconditions.html b/doc/html/boostbook/dtd/postconditions.html new file mode 100644 index 0000000000..2cf5a2e4b1 --- /dev/null +++ b/doc/html/boostbook/dtd/postconditions.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element postconditions</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="function.html" title=" + BoostBook element function"> +<link rel="next" href="compile-test.html" title=" + BoostBook element compile-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="function.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="compile-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.postconditions"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">postconditions</code></span></h2> +<p>postconditions — Conditions that must hold after the function returns</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">postconditions ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1677166"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="function.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="compile-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/precondition.html b/doc/html/boostbook/dtd/precondition.html new file mode 100644 index 0000000000..7b7ffe048d --- /dev/null +++ b/doc/html/boostbook/dtd/precondition.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element precondition</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="requirement.html" title=" + BoostBook element requirement"> +<link rel="next" href="paramtype.html" title=" + BoostBook element paramtype"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirement.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="paramtype.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.precondition"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">precondition</code></span></h2> +<p>precondition — Conditions that must be met prior to executing a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">precondition ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1696726"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirement.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="paramtype.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/programlisting.html b/doc/html/boostbook/dtd/programlisting.html new file mode 100644 index 0000000000..bd20b53183 --- /dev/null +++ b/doc/html/boostbook/dtd/programlisting.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element programlisting</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="overloaded-method.html" title=" + BoostBook element overloaded-method"> +<link rel="next" href="complexity.html" title=" + BoostBook element complexity"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-method.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="complexity.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.programlisting"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">programlisting</code></span></h2> +<p>programlisting — A sample of program code</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">programlisting ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1699077"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody><tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-method.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="complexity.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/purpose.html b/doc/html/boostbook/dtd/purpose.html new file mode 100644 index 0000000000..f2a812cd18 --- /dev/null +++ b/doc/html/boostbook/dtd/purpose.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element purpose</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="complexity.html" title=" + BoostBook element complexity"> +<link rel="next" href="template-nontype-parameter.html" title=" + BoostBook element template-nontype-parameter"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="complexity.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-nontype-parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.purpose"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">purpose</code></span></h2> +<p>purpose — A short description of an entity's use</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">purpose ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1699209"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="complexity.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-nontype-parameter.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/rationale.html b/doc/html/boostbook/dtd/rationale.html new file mode 100644 index 0000000000..6b00e4a4cd --- /dev/null +++ b/doc/html/boostbook/dtd/rationale.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element rationale</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="header.html" title=" + BoostBook element header"> +<link rel="next" href="../../bbv2.html" title="Part III. Boost.Build v2 User Manual"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="header.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bbv2.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.rationale"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">rationale</code></span></h2> +<p>rationale — Describes the rationale for a particular function's design</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">rationale ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1700924"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="header.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="../../bbv2.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/requirement.html b/doc/html/boostbook/dtd/requirement.html new file mode 100644 index 0000000000..5176b7d26d --- /dev/null +++ b/doc/html/boostbook/dtd/requirement.html @@ -0,0 +1,82 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element requirement</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="method-group.html" title=" + BoostBook element method-group"> +<link rel="next" href="precondition.html" title=" + BoostBook element precondition"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method-group.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="precondition.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.requirement"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">requirement</code></span></h2> +<p>requirement — A requirement/property in the Jamfile for a testcase</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">requirement ::= + (#PCDATA) +</div> +<div class="refsection" lang="en"> +<a name="id1696643"></a><h2>Description</h2> +<p>A requirement is part of the dependencies of a target in a + Jamfile. The <code class="computeroutput">name</code> attribute of a requirement element + gives the name of the Boost.Build feature and the content of the + requirement gives the value of that feature. A requirement such as + <code class="computeroutput"><includes>foo.hpp</code> would be encoded as + <code class="computeroutput"><requirement + name="includes">foo.hpp</requirement></code>.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1696672"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody><tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method-group.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="precondition.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/requires.html b/doc/html/boostbook/dtd/requires.html new file mode 100644 index 0000000000..459549cb81 --- /dev/null +++ b/doc/html/boostbook/dtd/requires.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element requires</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="enum.html" title=" + BoostBook element enum"> +<link rel="next" href="effects.html" title=" + BoostBook element effects"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enum.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="effects.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.requires"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">requires</code></span></h2> +<p>requires — Declares the requirements of a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">requires ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1700391"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enum.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="effects.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/returns.html b/doc/html/boostbook/dtd/returns.html new file mode 100644 index 0000000000..a9978aefd1 --- /dev/null +++ b/doc/html/boostbook/dtd/returns.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element returns</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="compile-fail-test.html" title=" + BoostBook element compile-fail-test"> +<link rel="next" href="default.html" title=" + BoostBook element default"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="default.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.returns"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">returns</code></span></h2> +<p>returns — Description of the return value of a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">returns ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1697685"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="default.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/run-fail-test.html b/doc/html/boostbook/dtd/run-fail-test.html new file mode 100644 index 0000000000..223dfdf06d --- /dev/null +++ b/doc/html/boostbook/dtd/run-fail-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element run-fail-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="copy-assignment.html" title=" + BoostBook element copy-assignment"> +<link rel="next" href="template.html" title=" + BoostBook element template"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy-assignment.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.run-fail-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">run-fail-test</code></span></h2> +<p>run-fail-test — A testcase that should compile and link, but fail on execution</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">run-fail-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1697416"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy-assignment.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/run-test.html b/doc/html/boostbook/dtd/run-test.html new file mode 100644 index 0000000000..419cb2d5b9 --- /dev/null +++ b/doc/html/boostbook/dtd/run-test.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element run-test</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="using-class.html" title=" + BoostBook element using-class"> +<link rel="next" href="librarypurpose.html" title=" + BoostBook element librarypurpose"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-class.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarypurpose.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.run-test"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">run-test</code></span></h2> +<p>run-test — A testcase that should compile, link, and execute</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">run-test ::= + (<a href="source.html" title=" + BoostBook element source">source</a>*, <a href="lib.html" title=" + BoostBook element lib">lib</a>*, <a href="requirement.html" title=" + BoostBook element requirement">requirement</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>, <a href="if-fails.html" title=" + BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1697006"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>filename</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the file associated with this element</td> +</tr> +<tr> +<td>name</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-class.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="librarypurpose.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/signature.html b/doc/html/boostbook/dtd/signature.html new file mode 100644 index 0000000000..02f0fe0240 --- /dev/null +++ b/doc/html/boostbook/dtd/signature.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element signature</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="parameter.html" title=" + BoostBook element parameter"> +<link rel="next" href="overloaded-function.html" title=" + BoostBook element overloaded-function"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-function.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.signature"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">signature</code></span></h2> +<p>signature — One signature of an overloaded function or method</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">signature ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="type.html" title=" + BoostBook element type">type</a>, <a href="parameter.html" title=" + BoostBook element parameter">parameter</a>*) +</div> +<div class="refsection" lang="en"> +<a name="id1697931"></a><h2>Description</h2> +<p> + A signature refers to one declaration of an overloaded function or + method. The signature itself has no name, because the name of the + overloaded function or method is used. An overloaded function or + method will have several signatures that will generally be typeset + together. + </p> +</div> +<div class="refsection" lang="en"> +<a name="id1697942"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>cv</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>cv-qualifiers for this method, e.g., const volatile</td> +</tr> +<tr> +<td>specifiers</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The specifiers for this function, e.g., inline, static, etc.</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="parameter.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-function.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/snippet.html b/doc/html/boostbook/dtd/snippet.html new file mode 100644 index 0000000000..f30ab5356e --- /dev/null +++ b/doc/html/boostbook/dtd/snippet.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element snippet</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="method.html" title=" + BoostBook element method"> +<link rel="next" href="constructor.html" title=" + BoostBook element constructor"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="constructor.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.snippet"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">snippet</code></span></h2> +<p>snippet — Pulls in a code snippet from a <code class="sgmltag-element">programlisting</code> element</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">snippet ::= + EMPTY +</div> +<div class="refsection" lang="en"> +<a name="id1677569"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody><tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the <code class="sgmltag-element">programlisting</code> element to insert</td> +</tr></tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="constructor.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/source.html b/doc/html/boostbook/dtd/source.html new file mode 100644 index 0000000000..db9d25f254 --- /dev/null +++ b/doc/html/boostbook/dtd/source.html @@ -0,0 +1,64 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element source</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="template-varargs.html" title=" + BoostBook element template-varargs"> +<link rel="next" href="function.html" title=" + BoostBook element function"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-varargs.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="function.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.source"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">source</code></span></h2> +<p>source — Defines source code for a test</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">source ::= + (#PCDATA| <a href="snippet.html" title=" + BoostBook element snippet">snippet</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1676873"></a><h2>Description</h2> +<p>This element will contain the source code for a testcase that + will be generated from the documentation. To reduce the amount of escaping in the text, it is recommended to use CDATA sections, which look like this: + + </p> +<pre class="programlisting"><![CDATA[ +<your program text here: no escaping needed!> +]]></pre> +<p>In addition to CDATA sections, code snippets can be pulled in + from <code class="sgmltag-element">programlisting</code> elements using the <a href="snippet.html" title=" + BoostBook element snippet"><code class="sgmltag-element">snippet</code></a> + element.</p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-varargs.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="function.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/specialization.html b/doc/html/boostbook/dtd/specialization.html new file mode 100644 index 0000000000..e090741b38 --- /dev/null +++ b/doc/html/boostbook/dtd/specialization.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element specialization</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="data-member.html" title=" + BoostBook element data-member"> +<link rel="next" href="union-specialization.html" title=" + BoostBook element union-specialization"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="data-member.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="union-specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.specialization"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">specialization</code></span></h2> +<p>specialization — Defines the specialization arguments for a class specialization</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">specialization ::= + (<a href="template-arg.html" title=" + BoostBook element template-arg">template-arg</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1696040"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="data-member.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="union-specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/static-constant.html b/doc/html/boostbook/dtd/static-constant.html new file mode 100644 index 0000000000..19c3283dab --- /dev/null +++ b/doc/html/boostbook/dtd/static-constant.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element static-constant</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="typedef.html" title=" + BoostBook element typedef"> +<link rel="next" href="code.html" title=" + BoostBook element code"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="typedef.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="code.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.static-constant"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">static-constant</code></span></h2> +<p>static-constant — Declares a static constant, e.g., <code class="computeroutput">const int foo = 5;</code>.</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">static-constant ::= + (<a href="type.html" title=" + BoostBook element type">type</a>, <a href="default.html" title=" + BoostBook element default">default</a>, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675493"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="typedef.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="code.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/struct-specialization.html b/doc/html/boostbook/dtd/struct-specialization.html new file mode 100644 index 0000000000..096585ffeb --- /dev/null +++ b/doc/html/boostbook/dtd/struct-specialization.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element struct-specialization</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="using-namespace.html" title=" + BoostBook element using-namespace"> +<link rel="next" href="struct.html" title=" + BoostBook element struct"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-namespace.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="struct.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.struct-specialization"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">struct-specialization</code></span></h2> +<p>struct-specialization — A specialization (full or partial) of a struct template</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">struct-specialization ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="specialization.html" title=" + BoostBook element specialization">specialization</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>?, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1699906"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-namespace.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="struct.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/struct.html b/doc/html/boostbook/dtd/struct.html new file mode 100644 index 0000000000..ade2ee0ff4 --- /dev/null +++ b/doc/html/boostbook/dtd/struct.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element struct</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="struct-specialization.html" title=" + BoostBook element struct-specialization"> +<link rel="next" href="lib.html" title=" + BoostBook element lib"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="lib.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.struct"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">struct</code></span></h2> +<p>struct — Declares a C++ struct</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">struct ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1700164"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="lib.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/template-arg.html b/doc/html/boostbook/dtd/template-arg.html new file mode 100644 index 0000000000..c251edc63d --- /dev/null +++ b/doc/html/boostbook/dtd/template-arg.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element template-arg</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="throws.html" title=" + BoostBook element throws"> +<link rel="next" href="method-group.html" title=" + BoostBook element method-group"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="throws.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="method-group.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.template-arg"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">template-arg</code></span></h2> +<p>template-arg — A template argument in a specialization</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">template-arg ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1696462"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="throws.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="method-group.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/template-nontype-parameter.html b/doc/html/boostbook/dtd/template-nontype-parameter.html new file mode 100644 index 0000000000..f2be365f42 --- /dev/null +++ b/doc/html/boostbook/dtd/template-nontype-parameter.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element template-nontype-parameter</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="purpose.html" title=" + BoostBook element purpose"> +<link rel="next" href="library.html" title=" + BoostBook element library"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="purpose.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="library.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.template-nontype-parameter"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">template-nontype-parameter</code></span></h2> +<p>template-nontype-parameter — A nontype template parameter</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">template-nontype-parameter ::= + (<a href="type.html" title=" + BoostBook element type">type</a>, <a href="default.html" title=" + BoostBook element default">default</a>?, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1699310"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="purpose.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="library.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/template-type-parameter.html b/doc/html/boostbook/dtd/template-type-parameter.html new file mode 100644 index 0000000000..3f9c5ce0b7 --- /dev/null +++ b/doc/html/boostbook/dtd/template-type-parameter.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element template-type-parameter</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="destructor.html" title=" + BoostBook element destructor"> +<link rel="next" href="description.html" title=" + BoostBook element description"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="destructor.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.template-type-parameter"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">template-type-parameter</code></span></h2> +<p>template-type-parameter — Declares a template type parameter</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">template-type-parameter ::= + (<a href="default.html" title=" + BoostBook element default">default</a>?, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675874"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="destructor.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/template-varargs.html b/doc/html/boostbook/dtd/template-varargs.html new file mode 100644 index 0000000000..1a64015e4d --- /dev/null +++ b/doc/html/boostbook/dtd/template-varargs.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element template-varargs</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="inherit.html" title=" + BoostBook element inherit"> +<link rel="next" href="source.html" title=" + BoostBook element source"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inherit.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="source.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.template-varargs"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">template-varargs</code></span></h2> +<p>template-varargs — Declares a variable-length list of template parameters</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">template-varargs ::= + EMPTY +</div> +<div class="refsection" lang="en"> +<a name="id1676778"></a><h2>Description</h2> +<p>Variable-length template parameter lists are not allowed in + C++, but because they are sometimes needed in documentation they are + allowed in BoostBook. This element generally expands to "..." and + can be used anywhere any other template parameter can be + used.</p> +</div> +<div class="refsection" lang="en"> +<a name="id1676789"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inherit.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="source.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/template.html b/doc/html/boostbook/dtd/template.html new file mode 100644 index 0000000000..78ca358de0 --- /dev/null +++ b/doc/html/boostbook/dtd/template.html @@ -0,0 +1,89 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element template</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="run-fail-test.html" title=" + BoostBook element run-fail-test"> +<link rel="next" href="compile-fail-test.html" title=" + BoostBook element compile-fail-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="compile-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.template"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">template</code></span></h2> +<p>template — Declares the template parameters of a class or function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">template ::= + (<a href="template-type-parameter.html" title=" + BoostBook element template-type-parameter">template-type-parameter</a>| <a href="template-nontype-parameter.html" title=" + BoostBook element template-nontype-parameter">template-nontype-parameter</a>| <a href="template-varargs.html" title=" + BoostBook element template-varargs">template-varargs</a>)* +</div> +<div class="refsection" lang="en"> +<a name="id1697505"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="compile-fail-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/testsuite.html b/doc/html/boostbook/dtd/testsuite.html new file mode 100644 index 0000000000..248b34b303 --- /dev/null +++ b/doc/html/boostbook/dtd/testsuite.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element testsuite</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="libraryinfo.html" title=" + BoostBook element libraryinfo"> +<link rel="next" href="header.html" title=" + BoostBook element header"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryinfo.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="header.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.testsuite"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">testsuite</code></span></h2> +<p>testsuite — Describes a library testsuite</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">testsuite ::= + ((<a href="compile-test.html" title=" + BoostBook element compile-test">compile-test</a>| <a href="link-test.html" title=" + BoostBook element link-test">link-test</a>| <a href="run-test.html" title=" + BoostBook element run-test">run-test</a>| <a href="compile-fail-test.html" title=" + BoostBook element compile-fail-test">compile-fail-test</a>| <a href="link-fail-test.html" title=" + BoostBook element link-fail-test">link-fail-test</a>| <a href="run-fail-test.html" title=" + BoostBook element run-fail-test">run-fail-test</a>)+) +</div> +<div class="refsection" lang="en"> +<a name="id1700758"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryinfo.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="header.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/throws.html b/doc/html/boostbook/dtd/throws.html new file mode 100644 index 0000000000..07e3e0ebae --- /dev/null +++ b/doc/html/boostbook/dtd/throws.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element throws</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="union-specialization.html" title=" + BoostBook element union-specialization"> +<link rel="next" href="template-arg.html" title=" + BoostBook element template-arg"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-arg.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.throws"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">throws</code></span></h2> +<p>throws — Description of the exceptions thrown by a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">throws ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1696385"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union-specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="template-arg.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/type.html b/doc/html/boostbook/dtd/type.html new file mode 100644 index 0000000000..579a228825 --- /dev/null +++ b/doc/html/boostbook/dtd/type.html @@ -0,0 +1,86 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element type</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarycategorydef.html" title=" + BoostBook element librarycategorydef"> +<link rel="next" href="enumvalue.html" title=" + BoostBook element enumvalue"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorydef.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="enumvalue.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.type"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">type</code></span></h2> +<p>type — The type of an element or return type of a function</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">type ::= + (ANY) +</div> +<div class="refsection" lang="en"> +<a name="id1698720"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorydef.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="enumvalue.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/typedef.html b/doc/html/boostbook/dtd/typedef.html new file mode 100644 index 0000000000..070df353c6 --- /dev/null +++ b/doc/html/boostbook/dtd/typedef.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element typedef</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="link-fail-test.html" title=" + BoostBook element link-fail-test"> +<link rel="next" href="static-constant.html" title=" + BoostBook element static-constant"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="static-constant.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.typedef"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">typedef</code></span></h2> +<p>typedef — Declares a typedef</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">typedef ::= + (<a href="type.html" title=" + BoostBook element type">type</a>, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?) +</div> +<div class="refsection" lang="en"> +<a name="id1675370"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-fail-test.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="static-constant.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/union-specialization.html b/doc/html/boostbook/dtd/union-specialization.html new file mode 100644 index 0000000000..dc11d106d1 --- /dev/null +++ b/doc/html/boostbook/dtd/union-specialization.html @@ -0,0 +1,116 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element union-specialization</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="specialization.html" title=" + BoostBook element specialization"> +<link rel="next" href="throws.html" title=" + BoostBook element throws"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="throws.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.union-specialization"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">union-specialization</code></span></h2> +<p>union-specialization — A specialization (full or partial) of a union template</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">union-specialization ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="specialization.html" title=" + BoostBook element specialization">specialization</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>?, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1696296"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="specialization.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="throws.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/union.html b/doc/html/boostbook/dtd/union.html new file mode 100644 index 0000000000..6630e7c6c5 --- /dev/null +++ b/doc/html/boostbook/dtd/union.html @@ -0,0 +1,115 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element union</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="boostbook.html" title=" + BoostBook element boostbook"> +<link rel="next" href="inherit.html" title=" + BoostBook element inherit"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="boostbook.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="inherit.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.union"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">union</code></span></h2> +<p>union — Declares a C++ union or union template</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">union ::= + (<a href="template.html" title=" + BoostBook element template">template</a>?, <a href="inherit.html" title=" + BoostBook element inherit">inherit</a>*, <a href="purpose.html" title=" + BoostBook element purpose">purpose</a>?, <a href="description.html" title=" + BoostBook element description">description</a>?, (<a href="static-constant.html" title=" + BoostBook element static-constant">static-constant</a>| <a href="typedef.html" title=" + BoostBook element typedef">typedef</a>| <a href="enum.html" title=" + BoostBook element enum">enum</a>| <a href="copy-assignment.html" title=" + BoostBook element copy-assignment">copy-assignment</a>| <a href="constructor.html" title=" + BoostBook element constructor">constructor</a>| <a href="destructor.html" title=" + BoostBook element destructor">destructor</a>| <a href="method-group.html" title=" + BoostBook element method-group">method-group</a>| <a href="free-function-group.html" title=" + BoostBook element free-function-group">free-function-group</a>| <a href="function.html" title=" + BoostBook element function">function</a>| <a href="method.html" title=" + BoostBook element method">method</a>| <a href="overloaded-function.html" title=" + BoostBook element overloaded-function">overloaded-function</a>| <a href="overloaded-method.html" title=" + BoostBook element overloaded-method">overloaded-method</a>| <a href="data-member.html" title=" + BoostBook element data-member">data-member</a>| <a href="class.html" title=" + BoostBook element class">class</a>| <a href="class-specialization.html" title=" + BoostBook element class-specialization">class-specialization</a>| <a href="struct.html" title=" + BoostBook element struct">struct</a>| <a href="struct-specialization.html" title=" + BoostBook element struct-specialization">struct-specialization</a>| <a href="union.html" title=" + BoostBook element union">union</a>| <a href="union-specialization.html" title=" + BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1676591"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="boostbook.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="inherit.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/using-class.html b/doc/html/boostbook/dtd/using-class.html new file mode 100644 index 0000000000..8832685922 --- /dev/null +++ b/doc/html/boostbook/dtd/using-class.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element using-class</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="paramtype.html" title=" + BoostBook element paramtype"> +<link rel="next" href="run-test.html" title=" + BoostBook element run-test"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="paramtype.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="run-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.using-class"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">using-class</code></span></h2> +<p>using-class — Injects the method and function names of a class into the local scope</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">using-class ::= + EMPTY +</div> +<div class="refsection" lang="en"> +<a name="id1696881"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="paramtype.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="run-test.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/using-namespace.html b/doc/html/boostbook/dtd/using-namespace.html new file mode 100644 index 0000000000..3389b733c7 --- /dev/null +++ b/doc/html/boostbook/dtd/using-namespace.html @@ -0,0 +1,92 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element using-namespace</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarycategorylist.html" title=" + BoostBook element librarycategorylist"> +<link rel="next" href="struct-specialization.html" title=" + BoostBook element struct-specialization"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="struct-specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.using-namespace"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">using-namespace</code></span></h2> +<p>using-namespace — Injects the declared names from a namespace into the local scope</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">using-namespace ::= + EMPTY +</div> +<div class="refsection" lang="en"> +<a name="id1699637"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Name</th> +<th>Type</th> +<th>Value</th> +<th>Purpose</th> +</tr></thead> +<tbody> +<tr> +<td>last-revision</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>name</td> +<td>#REQUIRED</td> +<td>CDATA</td> +<td>The name of the element being declared to referenced</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>xml:base</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Implementation detail used by XIncludes</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="struct-specialization.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> |