diff options
| author | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
|---|---|---|
| committer | Anas Nashif <anas.nashif@intel.com> | 2012-10-30 12:57:26 -0700 |
| commit | 1a78a62555be32868418fe52f8e330c9d0f95d5a (patch) | |
| tree | d3765a80e7d3b9640ec2e930743630cd6b9fce2b /doc/html/boostbook | |
| download | boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.gz boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.tar.bz2 boost-1a78a62555be32868418fe52f8e330c9d0f95d5a.zip | |
Imported Upstream version 1.49.0upstream/1.49.0
Diffstat (limited to 'doc/html/boostbook')
80 files changed, 7732 insertions, 0 deletions
diff --git a/doc/html/boostbook/documenting.html b/doc/html/boostbook/documenting.html new file mode 100755 index 0000000000..f986dc3053 --- /dev/null +++ b/doc/html/boostbook/documenting.html @@ -0,0 +1,253 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Documenting libraries</title> +<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../boostbook.html" title="Chapter 36. The BoostBook Documentation Format"> +<link rel="prev" href="getting/started.html" title="Getting Started"> +<link rel="next" href="together.html" title="Bringing Together a BoostBook Document"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> +<td align="center"><a href="../../../index.html">Home</a></td> +<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="getting/started.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="together.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="boostbook.documenting"></a>Documenting libraries</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="documenting.html#boostbook.defining">Defining a BoostBook library</a></span></dt> +<dt><span class="section"><a href="documenting.html#id3852549">From HTML to BoostBook</a></span></dt> +<dt><span class="section"><a href="documenting.html#boostbook.sectioning">Sectioning in BoostBook</a></span></dt> +</dl></div> +<p>BoostBook is an extension to <a href="http://www.docbook.org" target="_top">DocBook</a>, an XML format for + representing documentation. BoostBook inherits much of its + functionality and many elements from DocBook that are not + redocumented here. When writing BoostBook documentation, please + refer also to <a href="http://docbook.org/tdg/en/index.html" target="_top">DocBook: The Definitive + Guide</a>.</p> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.defining"></a>Defining a BoostBook library</h3></div></div></div> +<p>BoostBook library documentation is contained entirely within + a <library> XML element. To create a skeletal library, we + need to create a new XML document (call it <code class="computeroutput">any.xml</code>) + that contains basic information about the library. The following + <a class="link" href="documenting.html#boostbook.documenting.skeletal" title="Example 36.1. A Skeletal BoostBook Library">BoostBook XML + example</a> describes basic information about the <a href="http://www.boost.org/libs/any/index.html" target="_top">Boost.Any</a> + library:</p> +<div class="example"> +<a name="boostbook.documenting.skeletal"></a><p class="title"><b>Example 36.1. A Skeletal BoostBook Library</b></p> +<div class="example-contents"><pre class="programlisting"> +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" + "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"> +<library name="Any" dirname="any" xmlns:xi="http://www.w3.org/2001/XInclude" + id="any" last-revision="$Date: 2008-07-12 20:30:45 +0100 (Sat, 12 Jul 2008) $"> + <libraryinfo> + <author> + <firstname>Kevlin</firstname> + <surname>Henney</surname> + </author> + <librarypurpose> + Safe, generic container for single values of different value types + </librarypurpose> + <librarycategory name="category:data-structures"/> + </libraryinfo> +</library> +</pre></div> +</div> +<br class="example-break"><p>The first three lines identify this document as a BoostBook + <a href="http://www.w3.org/XML/" target="_top">XML</a> document. The + DOCTYPE line states that the document conforms to the BoostBook + DTD, and that the top-level element is a BoostBook + <library>.</p> +<p>The <library> element actually describes the aspects + of BoostBook library documentation. The attributes for the + <library> element are:</p> +<div class="variablelist"> +<p class="title"><b>Attributes for the <library> element</b></p> +<dl> +<dt><span class="term"><code class="computeroutput">name</code></span></dt> +<dd>The full name of the library, e.g., "Any"</dd> +<dt><span class="term"><code class="computeroutput">dirname</code></span></dt> +<dd>The name of the directory, relative to + <code class="computeroutput">boost/libs</code>, in which the library + resides. This name may be a relative path, such as + <code class="computeroutput">math/octonion</code>, using "/" for the directory + separator.</dd> +<dt><span class="term"><code class="computeroutput">id</code></span></dt> +<dd>A short, unique name for the library. For libraries + with simple directory names (e.g., ones that do not contain + a "/"), this should be the same as the + <code class="computeroutput">dirname</code>. This <code class="computeroutput">id</code> will be used to + identify libraries and, for HTML output, will be used as the + base name for the HTML file in which the library's + documentation resides, so it should use only lowercase + alphanumeric characters and underscores.</dd> +<dt><span class="term"><code class="computeroutput">last-revision</code></span></dt> +<dd>Always set to <code class="computeroutput">$Date: 2008-07-12 20:30:45 +0100 (Sat, 12 Jul 2008) $</code>, which is + expanded by CVS to include the date and time that the file + was last modified.</dd> +</dl> +</div> +<p>Inside the <library> element we have the + <libraryinfo> element, which gives information about the + library itself. It contains the author's name (there may be more + than one <author> element), followed by the purpose of the + library and the list of categorizations. The + <librarypurpose> element should always contain a very short + (single sentence) description of the library's purpose, and should + <span class="emphasis"><em>not</em></span> terminate with a period.</p> +<p>The list of categories is specified by a set of + <librarycategory> elements. Each <librarycategory> + element has a <code class="computeroutput">name</code> element that identifies one of the + categories. The actual list of categories is in the file + <code class="filename">doc/src/boost.xml</code>. + </p> +<p>At this point, we can apply the BoostBook XSL stylesheets to + <code class="computeroutput">any.xml</code> (to DocBook) followed by a DocBook XSL + stylesheet to generate HTML output, as described in <a class="xref" href="getting/started.html" title="Getting Started">the section called “Getting Started”</a>.</p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="id3852549"></a>From HTML to BoostBook</h3></div></div></div> +<p>Most library authors are comfortable with writing HTML + documentation. Writing <a href="http://www.docbook.org" target="_top">DocBook</a> documentation (and, + by extension, BoostBook documentation) is quite similar to writing + HTML, except that BoostBook uses different element names from HTML + (see <a class="xref" href="documenting.html#html.to.boostbook" title="Table 36.2. Converting HTML elements to BoostBook">Table 36.2, “Converting HTML elements to BoostBook”</a>) and BoostBook XML is a + much more rigid format than HTML.</p> +<p>One of the easiest ways to convert HTML documentation into + BoostBook documentation is to use <a href="http://tidy.sourceforge.net/" target="_top">HTML Tidy</a> to transform + your HTML into valid XHTML, which will make sure that all elements + are properly closed, then apply the transformations in <a class="xref" href="documenting.html#html.to.boostbook" title="Table 36.2. Converting HTML elements to BoostBook">Table 36.2, “Converting HTML elements to BoostBook”</a> to the body of the XHTML + document. The following command uses HTML Tidy to transform HTML + into valid XHTML:</p> +<pre class="programlisting"> + tidy -asxhtml input.html > output.xhtml</pre> +<p>When converting documentation from HTML to BoostBook, note + that some redundant information that has to be manually maintained + in HTML is automatically generated in BoostBook: for instance, the + library categorizations, purpose, and author list described in + <a class="xref" href="documenting.html#boostbook.defining" title="Defining a BoostBook library">the section called “Defining a BoostBook library”</a> are used both in the + documentation for the library and to build alphabetical and + categorized lists of known libraries; similarly, tables of + contents are built automatically from the titles of sections in + the BoostBook document.</p> +<div class="table"> +<a name="html.to.boostbook"></a><p class="title"><b>Table 36.2. Converting HTML elements to BoostBook</b></p> +<div class="table-contents"><table class="table" summary="Converting HTML elements to BoostBook"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th align="left">HTML</th> +<th align="left">BoostBook</th> +</tr></thead> +<tbody> +<tr> +<td align="left"><p><h1>, <h2>, etc.</p></td> +<td align="left"> +<p><section>, <title>; See <a class="xref" href="documenting.html#boostbook.sectioning" title="Sectioning in BoostBook">the section called “Sectioning in BoostBook”</a></p> +</td> +</tr> +<tr> +<td align="left"><p><i>, <em></p></td> +<td align="left"><p><emphasis></p></td> +</tr> +<tr> +<td align="left"><p><b></p></td> +<td align="left"><p><emphasis role="bold"></p></td> +</tr> +<tr> +<td align="left"><p><ol></p></td> +<td align="left"><p><orderedlist></p></td> +</tr> +<tr> +<td align="left"><p><ul></p></td> +<td align="left"><p><itemizedlist></p></td> +</tr> +<tr> +<td align="left"><p><li></p></td> +<td align="left"><p><listitem></p></td> +</tr> +<tr> +<td align="left"><p><pre></p></td> +<td align="left"><p><programlisting></p></td> +</tr> +<tr> +<td align="left"><p><code></p></td> +<td align="left"><p><computeroutput>,<code></p></td> +</tr> +<tr> +<td align="left"><p><p></p></td> +<td align="left"><p><para>, <simpara></p></td> +</tr> +<tr> +<td align="left"><p><a></p></td> +<td align="left"> +<p><xref>, <link>, <ulink>;, See <a class="xref" href="together.html#boostbook.linking" title="Linking in BoostBook">the section called “Linking in BoostBook”</a></p> +</td> +</tr> +<tr> +<td align="left"><p><table>, <tr>, <th>, <td></p></td> +<td align="left"><p><table>, <informaltable>, <tgroup>, <thead>, <tfoot>, <tbody>, <row>, <entry>, <entrytbl>; BoostBook tables are equivalent to DocBook tables, for which there is a good <a href="http://opensource.bureau-cornavin.com/crash-course/en/tables.html" target="_top">tutorial here</a></p></td> +</tr> +</tbody> +</table></div> +</div> +<br class="table-break"> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.sectioning"></a>Sectioning in BoostBook</h3></div></div></div> +<p>"Sectioning" refers to organization of a document into separate sections, each with a title, some text, and possibly subsections. Each section is described in BoostBook via a <section> element. An introduction section may look like this:</p> +<pre class="programlisting"> +<section id="any.intro"> + <title>Introduction</title> + + <para>Introduction to a library...</para> + + <section> + <title>A Subsection</title> + <para>Subsection information...</para> + </section> +</section> +</pre> +<p>The <section> element contains all information that + should logically be grouped within that section. The title of the + section is placed within the <title> element, and any + paragraphs, programs, lists, tables, or subsections can occur + within the section. The <code class="computeroutput">id</code> attribute of the + <section> element gives a unique ID to each section, so that + it may later be identified for linking. It is suggested that all + IDs start with the short name of a library followed by a period, + so that IDs do not conflict between libraries.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="getting/started.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="together.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/access.html b/doc/html/boostbook/dtd/access.html new file mode 100755 index 0000000000..61c54f45cb --- /dev/null +++ b/doc/html/boostbook/dtd/access.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element access</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="overloaded-function.html" title="BoostBook element overloaded-function"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-function.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="class.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boostbook.dtd.access"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">access</code></span></h2> +<p>access — Declares an access specification for class members</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">access ::= + (<a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)+ +</div> +<div class="refsection"> +<a name="id3862613"></a><h2>Description</h2> +<p>The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element.</p> +</div> +<div class="refsection"> +<a name="id3862628"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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 access specification, e.g. "public", "private", or "protected".</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-function.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="class.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/boostbook.html b/doc/html/boostbook/dtd/boostbook.html new file mode 100755 index 0000000000..e84e35c16c --- /dev/null +++ b/doc/html/boostbook/dtd/boostbook.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element boostbook</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library-reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="union.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="library.html" title="BoostBook element library">library</a>)*) +</div> +<div class="refsection"> +<a name="id3856092"></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"> +<a name="id3856109"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library-reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="union.html"><img src="../../../../doc/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 100755 index 0000000000..94120f6234 --- /dev/null +++ b/doc/html/boostbook/dtd/class-specialization.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element class-specialization</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="link-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="specialization.html" title="BoostBook element specialization">specialization</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3854419"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../reference.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="link-test.html"><img src="../../../../doc/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 100755 index 0000000000..ee4982e93c --- /dev/null +++ b/doc/html/boostbook/dtd/class.html @@ -0,0 +1,134 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element class</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="access.html" title="BoostBook element access"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="access.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorydef.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3862914"></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 class="link" 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 class="link" href="../../boost/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"> +<a name="id3863050"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="access.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorydef.html"><img src="../../../../doc/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 100755 index 0000000000..3fe4efac80 --- /dev/null +++ b/doc/html/boostbook/dtd/code.html @@ -0,0 +1,94 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element code</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static-constant.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="destructor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3855114"></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"> +<a name="id3855137"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="static-constant.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="destructor.html"><img src="../../../../doc/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 100755 index 0000000000..fd204124f4 --- /dev/null +++ b/doc/html/boostbook/dtd/compile-fail-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element compile-fail-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="returns.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3861394"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="returns.html"><img src="../../../../doc/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 100755 index 0000000000..a0436a41aa --- /dev/null +++ b/doc/html/boostbook/dtd/compile-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element compile-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="postconditions.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3857416"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="postconditions.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method.html"><img src="../../../../doc/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 100755 index 0000000000..03887f88d4 --- /dev/null +++ b/doc/html/boostbook/dtd/complexity.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element complexity</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="programlisting.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="purpose.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3863877"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="programlisting.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="purpose.html"><img src="../../../../doc/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 100755 index 0000000000..9378d3f295 --- /dev/null +++ b/doc/html/boostbook/dtd/constructor.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element constructor</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="snippet.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespace.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="parameter.html" title="BoostBook element parameter">parameter</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3857952"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3857970"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="snippet.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="namespace.html"><img src="../../../../doc/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 100755 index 0000000000..fb91f2d1bf --- /dev/null +++ b/doc/html/boostbook/dtd/copy-assignment.html @@ -0,0 +1,108 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element copy-assignment</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarypurpose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run-fail-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="type.html" title="BoostBook element type">type</a>?, <a class="link" href="parameter.html" title="BoostBook element parameter">parameter</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3860930"></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 class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3860955"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarypurpose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run-fail-test.html"><img src="../../../../doc/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 100755 index 0000000000..620e570148 --- /dev/null +++ b/doc/html/boostbook/dtd/data-member.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element data-member</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notes.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="specialization.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3859049"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="notes.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="specialization.html"><img src="../../../../doc/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 100755 index 0000000000..b3986519a1 --- /dev/null +++ b/doc/html/boostbook/dtd/default.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element default</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="returns.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="parameter.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3861600"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="returns.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="parameter.html"><img src="../../../../doc/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 100755 index 0000000000..a03ea93b56 --- /dev/null +++ b/doc/html/boostbook/dtd/description.html @@ -0,0 +1,97 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element description</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-type-parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarylist.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3855612"></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"> +<a name="id3855651"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-type-parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarylist.html"><img src="../../../../doc/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 100755 index 0000000000..283faae30d --- /dev/null +++ b/doc/html/boostbook/dtd/destructor.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element destructor</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="code.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-type-parameter.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3855320"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3855338"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="code.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-type-parameter.html"><img src="../../../../doc/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 100755 index 0000000000..91c76163a2 --- /dev/null +++ b/doc/html/boostbook/dtd/effects.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element effects</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requires.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="libraryname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3865705"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requires.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="libraryname.html"><img src="../../../../doc/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 100755 index 0000000000..2e8218b081 --- /dev/null +++ b/doc/html/boostbook/dtd/enum.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element enum</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lib.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="requires.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="enumvalue.html" title="BoostBook element enumvalue">enumvalue</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3865472"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="lib.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="requires.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/enumname.html b/doc/html/boostbook/dtd/enumname.html new file mode 100755 index 0000000000..b602c53bbe --- /dev/null +++ b/doc/html/boostbook/dtd/enumname.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element enumname</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="using-namespace.html" title="BoostBook element using-namespace"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-namespace.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="struct-specialization.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boostbook.dtd.enumname"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">enumname</code></span></h2> +<p>enumname</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">enumname ::= + (#PCDATA) +</div> +<div class="refsection"> +<a name="id3864690"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>alt</td> +<td>#IMPLIED</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> +</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-namespace.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="struct-specialization.html"><img src="../../../../doc/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 100755 index 0000000000..3f203711f6 --- /dev/null +++ b/doc/html/boostbook/dtd/enumvalue.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element enumvalue</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-method.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="default.html" title="BoostBook element default">default</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3863450"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="type.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-method.html"><img src="../../../../doc/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 100755 index 0000000000..34a82fffd6 --- /dev/null +++ b/doc/html/boostbook/dtd/free-function-group.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element free-function-group</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="headername.html" title="BoostBook element headername"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="headername.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functionname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>)* +</div> +<div class="refsection"> +<a name="id3858521"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="headername.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="functionname.html"><img src="../../../../doc/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 100755 index 0000000000..a3e6a2fd6f --- /dev/null +++ b/doc/html/boostbook/dtd/function.html @@ -0,0 +1,153 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element function</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="source.html" title="BoostBook element source"> +<link rel="next" href="macroname.html" title="BoostBook element macroname"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="macroname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="parameter.html" title="BoostBook element parameter">parameter</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3856976"></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 class="link" 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"> +<a name="id3857031"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="source.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="macroname.html"><img src="../../../../doc/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 100755 index 0000000000..7795addf6d --- /dev/null +++ b/doc/html/boostbook/dtd/functionname.html @@ -0,0 +1,102 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element functionname</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="free-function-group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3858643"></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 class="link" href="using-class.html" title="BoostBook element using-class"><code class="sgmltag-element">using-class</code></a> + and <a class="link" 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"> +<a name="id3858673"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>alt</td> +<td>#IMPLIED</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="free-function-group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/globalname.html b/doc/html/boostbook/dtd/globalname.html new file mode 100755 index 0000000000..1e798738fe --- /dev/null +++ b/doc/html/boostbook/dtd/globalname.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element globalname</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="template-arg.html" title="BoostBook element template-arg"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-arg.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method-group.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boostbook.dtd.globalname"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">globalname</code></span></h2> +<p>globalname</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">globalname ::= + (#PCDATA) +</div> +<div class="refsection"> +<a name="id3859841"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>alt</td> +<td>#IMPLIED</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> +</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-arg.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="method-group.html"><img src="../../../../doc/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 100755 index 0000000000..390acdbff3 --- /dev/null +++ b/doc/html/boostbook/dtd/header.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element header</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="testsuite.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3866204"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="testsuite.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="rationale.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/headername.html b/doc/html/boostbook/dtd/headername.html new file mode 100755 index 0000000000..cd2053c01d --- /dev/null +++ b/doc/html/boostbook/dtd/headername.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element headername</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="if-fails.html" title="BoostBook element if-fails"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="if-fails.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="free-function-group.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boostbook.dtd.headername"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">headername</code></span></h2> +<p>headername</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">headername ::= + (#PCDATA) +</div> +<div class="refsection"> +<a name="id3858395"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>alt</td> +<td>#IMPLIED</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> +</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="if-fails.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="free-function-group.html"><img src="../../../../doc/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 100755 index 0000000000..b51f49a69f --- /dev/null +++ b/doc/html/boostbook/dtd/if-fails.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element if-fails</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="namespace.html" title="BoostBook element namespace"> +<link rel="next" href="headername.html" title="BoostBook element headername"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="namespace.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headername.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3858349"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="namespace.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="headername.html"><img src="../../../../doc/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 100755 index 0000000000..ab2c58ef8b --- /dev/null +++ b/doc/html/boostbook/dtd/inherit.html @@ -0,0 +1,103 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element inherit</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-varargs.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 ::= + (<a class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?) +</div> +<div class="refsection"> +<a name="id3856534"></a><h2>Description</h2> +<p>This element contains the type of the class inherited.</p> +</div> +<div class="refsection"> +<a name="id3856544"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>access</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>The access specifier ("public", "private", or "protected") of the inheritance.</td> +</tr> +<tr> +<td>id</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>A global identifier for this element</td> +</tr> +<tr> +<td>pack</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to '1' if this is a pack exapansion.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-varargs.html"><img src="../../../../doc/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 100755 index 0000000000..f73d9783e6 --- /dev/null +++ b/doc/html/boostbook/dtd/lib.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element lib</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enum.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3865406"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enum.html"><img src="../../../../doc/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 100755 index 0000000000..17888effff --- /dev/null +++ b/doc/html/boostbook/dtd/library-reference.html @@ -0,0 +1,112 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element library-reference</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="header.html" title="BoostBook element header">header</a>| <a class="link" href="library-reference.html" title="BoostBook element library-reference">library-reference</a>)*) +</div> +<div class="refsection"> +<a name="id3855905"></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 class="link" href="../../any.html" title="Chapter 2. 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 class="link" href="../../any.html" title="Chapter 2. 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"> +<a name="id3855976"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../../../doc/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 100755 index 0000000000..0d91e2759d --- /dev/null +++ b/doc/html/boostbook/dtd/library.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element library</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-nontype-parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorylist.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="libraryinfo.html" title="BoostBook element libraryinfo">libraryinfo</a>, (title, ((section| <a class="link" href="library-reference.html" title="BoostBook element library-reference">library-reference</a>| <a class="link" href="testsuite.html" title="BoostBook element testsuite">testsuite</a>))+)?) +</div> +<div class="refsection"> +<a name="id3864279"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-nontype-parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarycategorylist.html"><img src="../../../../doc/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 100755 index 0000000000..46c34b3c00 --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategory.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element librarycategory</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="functionname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="notes.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3858794"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="functionname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="notes.html"><img src="../../../../doc/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 100755 index 0000000000..18fa726c51 --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategorydef.html @@ -0,0 +1,97 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element librarycategorydef</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3863172"></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"> +<a name="id3863194"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="type.html"><img src="../../../../doc/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 100755 index 0000000000..6f12590ce0 --- /dev/null +++ b/doc/html/boostbook/dtd/librarycategorylist.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element librarycategorylist</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="using-namespace.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="librarycategorydef.html" title="BoostBook element librarycategorydef">librarycategorydef</a>)* +</div> +<div class="refsection"> +<a name="id3864442"></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"> +<a name="id3864458"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="library.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="using-namespace.html"><img src="../../../../doc/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 100755 index 0000000000..3feab4f1b5 --- /dev/null +++ b/doc/html/boostbook/dtd/libraryinfo.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element libraryinfo</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="testsuite.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="librarypurpose.html" title="BoostBook element librarypurpose">librarypurpose</a>, <a class="link" href="librarycategory.html" title="BoostBook element librarycategory">librarycategory</a>*) +</div> +<div class="refsection"> +<a name="id3865941"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="testsuite.html"><img src="../../../../doc/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 100755 index 0000000000..3d34ea30da --- /dev/null +++ b/doc/html/boostbook/dtd/librarylist.html @@ -0,0 +1,91 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element librarylist</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library-reference.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3855762"></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"> +<a name="id3855779"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="description.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library-reference.html"><img src="../../../../doc/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 100755 index 0000000000..963b1140b2 --- /dev/null +++ b/doc/html/boostbook/dtd/libraryname.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element libraryname</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="effects.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="libraryinfo.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3865815"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="effects.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="libraryinfo.html"><img src="../../../../doc/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 100755 index 0000000000..cc3c416b84 --- /dev/null +++ b/doc/html/boostbook/dtd/librarypurpose.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element librarypurpose</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copy-assignment.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="code.html" title="BoostBook element code">code</a>| ulink| <a class="link" href="functionname.html" title="BoostBook element functionname">functionname</a>| methodname| classname| <a class="link" href="macroname.html" title="BoostBook element macroname">macroname</a>| <a class="link" href="headername.html" title="BoostBook element headername">headername</a>| <a class="link" href="enumname.html" title="BoostBook element enumname">enumname</a>| <a class="link" href="globalname.html" title="BoostBook element globalname">globalname</a>)* +</div> +<div class="refsection"> +<a name="id3860726"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="copy-assignment.html"><img src="../../../../doc/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 100755 index 0000000000..6abdaf9d94 --- /dev/null +++ b/doc/html/boostbook/dtd/link-fail-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element link-fail-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="typedef.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3854712"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="typedef.html"><img src="../../../../doc/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 100755 index 0000000000..c556a68842 --- /dev/null +++ b/doc/html/boostbook/dtd/link-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element link-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="link-fail-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3854578"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="class-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="link-fail-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/dtd/macroname.html b/doc/html/boostbook/dtd/macroname.html new file mode 100755 index 0000000000..edc5c779e1 --- /dev/null +++ b/doc/html/boostbook/dtd/macroname.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element macroname</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="function.html" title="BoostBook element function"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="function.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="postconditions.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boostbook.dtd.macroname"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">macroname</code></span></h2> +<p>macroname</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">macroname ::= + (#PCDATA) +</div> +<div class="refsection"> +<a name="id3857161"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>alt</td> +<td>#IMPLIED</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> +</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="function.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="postconditions.html"><img src="../../../../doc/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 100755 index 0000000000..52eaba7b9b --- /dev/null +++ b/doc/html/boostbook/dtd/method-group.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element method-group</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="globalname.html" title="BoostBook element globalname"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="globalname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="requirement.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>)* +</div> +<div class="refsection"> +<a name="id3859964"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="globalname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="requirement.html"><img src="../../../../doc/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 100755 index 0000000000..ff1e47ce7f --- /dev/null +++ b/doc/html/boostbook/dtd/method.html @@ -0,0 +1,111 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element method</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="snippet.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="parameter.html" title="BoostBook element parameter">parameter</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3857607"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3857625"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="snippet.html"><img src="../../../../doc/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 100755 index 0000000000..581b97bace --- /dev/null +++ b/doc/html/boostbook/dtd/namespace.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element namespace</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="constructor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="if-fails.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="namespace.html" title="BoostBook element namespace">namespace</a>)* +</div> +<div class="refsection"> +<a name="id3858184"></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 class="link" href="../../any.html" title="Chapter 2. 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"> +<a name="id3858229"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="constructor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="if-fails.html"><img src="../../../../doc/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 100755 index 0000000000..e5efb7f5df --- /dev/null +++ b/doc/html/boostbook/dtd/notes.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element notes</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="data-member.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3858917"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="data-member.html"><img src="../../../../doc/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 100755 index 0000000000..ec30b92f09 --- /dev/null +++ b/doc/html/boostbook/dtd/overloaded-function.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element overloaded-function</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="signature.html" title="BoostBook element signature"> +<link rel="next" href="access.html" title="BoostBook element access"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="signature.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="access.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="signature.html" title="BoostBook element signature">signature</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3862353"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3862371"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="signature.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="access.html"><img src="../../../../doc/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 100755 index 0000000000..f72dbfefc4 --- /dev/null +++ b/doc/html/boostbook/dtd/overloaded-method.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element overloaded-method</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="programlisting.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="signature.html" title="BoostBook element signature">signature</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, <a class="link" href="requires.html" title="BoostBook element requires">requires</a>?, <a class="link" href="effects.html" title="BoostBook element effects">effects</a>?, <a class="link" href="postconditions.html" title="BoostBook element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="BoostBook element returns">returns</a>?, <a class="link" href="throws.html" title="BoostBook element throws">throws</a>?, <a class="link" href="complexity.html" title="BoostBook element complexity">complexity</a>?, <a class="link" href="notes.html" title="BoostBook element notes">notes</a>?, <a class="link" href="rationale.html" title="BoostBook element rationale">rationale</a>?) +</div> +<div class="refsection"> +<a name="id3863652"></a><h2>Description</h2> +<p>General documentation on functions in BoostBook is provided in + the <a class="link" href="function.html" title="BoostBook element function"><code class="sgmltag-element">function</code></a> + element documentation.</p> +</div> +<div class="refsection"> +<a name="id3863670"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumvalue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="programlisting.html"><img src="../../../../doc/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 100755 index 0000000000..d0154b5f0e --- /dev/null +++ b/doc/html/boostbook/dtd/parameter.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element parameter</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="default.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signature.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="paramtype.html" title="BoostBook element paramtype">paramtype</a>, <a class="link" href="default.html" title="BoostBook element default">default</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3861733"></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> +<tr> +<td>pack</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to '1' if the parameter is a parameter pack.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="default.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="signature.html"><img src="../../../../doc/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 100755 index 0000000000..98159671cd --- /dev/null +++ b/doc/html/boostbook/dtd/paramtype.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element paramtype</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="precondition.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="using-class.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3860314"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="precondition.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="using-class.html"><img src="../../../../doc/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 100755 index 0000000000..4c0b594d2b --- /dev/null +++ b/doc/html/boostbook/dtd/postconditions.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element postconditions</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="macroname.html" title="BoostBook element macroname"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="macroname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="compile-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3857270"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="macroname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="compile-test.html"><img src="../../../../doc/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 100755 index 0000000000..2a4587fc56 --- /dev/null +++ b/doc/html/boostbook/dtd/precondition.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element precondition</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirement.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="paramtype.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3860204"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="requirement.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="paramtype.html"><img src="../../../../doc/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 100755 index 0000000000..ec126a64c0 --- /dev/null +++ b/doc/html/boostbook/dtd/programlisting.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element programlisting</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-method.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="complexity.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3863793"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overloaded-method.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="complexity.html"><img src="../../../../doc/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 100755 index 0000000000..615bdd220a --- /dev/null +++ b/doc/html/boostbook/dtd/purpose.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element purpose</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="complexity.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-nontype-parameter.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3863988"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="complexity.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-nontype-parameter.html"><img src="../../../../doc/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 100755 index 0000000000..4ae73a405b --- /dev/null +++ b/doc/html/boostbook/dtd/rationale.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element rationale</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="header.html" title="BoostBook element header"> +<link rel="next" href="../../quickbook.html" title="Chapter 37. Quickbook 1.5"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="header.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../quickbook.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3866328"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="header.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../quickbook.html"><img src="../../../../doc/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 100755 index 0000000000..8d4a58dde8 --- /dev/null +++ b/doc/html/boostbook/dtd/requirement.html @@ -0,0 +1,83 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element requirement</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method-group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="precondition.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3860087"></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"> +<a name="id3860119"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method-group.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="precondition.html"><img src="../../../../doc/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 100755 index 0000000000..4738e2b266 --- /dev/null +++ b/doc/html/boostbook/dtd/requires.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element requires</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enum.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="effects.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3865594"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enum.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="effects.html"><img src="../../../../doc/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 100755 index 0000000000..dc6c638916 --- /dev/null +++ b/doc/html/boostbook/dtd/returns.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element returns</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="default.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3861490"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="compile-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="default.html"><img src="../../../../doc/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 100755 index 0000000000..b1be8aa861 --- /dev/null +++ b/doc/html/boostbook/dtd/run-fail-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element run-fail-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy-assignment.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3861126"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="copy-assignment.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template.html"><img src="../../../../doc/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 100755 index 0000000000..30faef7597 --- /dev/null +++ b/doc/html/boostbook/dtd/run-test.html @@ -0,0 +1,81 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element run-test</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-class.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarypurpose.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="source.html" title="BoostBook element source">source</a>*, <a class="link" href="lib.html" title="BoostBook element lib">lib</a>*, <a class="link" href="requirement.html" title="BoostBook element requirement">requirement</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>, <a class="link" href="if-fails.html" title="BoostBook element if-fails">if-fails</a>?) +</div> +<div class="refsection"> +<a name="id3860584"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="using-class.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="librarypurpose.html"><img src="../../../../doc/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 100755 index 0000000000..bef436de83 --- /dev/null +++ b/doc/html/boostbook/dtd/signature.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element signature</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-function.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="parameter.html" title="BoostBook element parameter">parameter</a>*) +</div> +<div class="refsection"> +<a name="id3861852"></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"> +<a name="id3861866"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="parameter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overloaded-function.html"><img src="../../../../doc/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 100755 index 0000000000..ba0f1cc553 --- /dev/null +++ b/doc/html/boostbook/dtd/snippet.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element snippet</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="constructor.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3857776"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="method.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="constructor.html"><img src="../../../../doc/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 100755 index 0000000000..47b22d1e3d --- /dev/null +++ b/doc/html/boostbook/dtd/source.html @@ -0,0 +1,65 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element source</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-varargs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="function.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="snippet.html" title="BoostBook element snippet">snippet</a>)* +</div> +<div class="refsection"> +<a name="id3856811"></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> + </p> +<p>In addition to CDATA sections, code snippets can be pulled in + from <code class="sgmltag-element">programlisting</code> elements using the <a class="link" 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="template-varargs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="function.html"><img src="../../../../doc/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 100755 index 0000000000..2f215be334 --- /dev/null +++ b/doc/html/boostbook/dtd/specialization.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element specialization</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="data-member.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="union-specialization.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template-arg.html" title="BoostBook element template-arg">template-arg</a>)* +</div> +<div class="refsection"> +<a name="id3859192"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="data-member.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="union-specialization.html"><img src="../../../../doc/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 100755 index 0000000000..33525f0d7d --- /dev/null +++ b/doc/html/boostbook/dtd/static-constant.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element static-constant</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="typedef.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="code.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="default.html" title="BoostBook element default">default</a>, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3854988"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="typedef.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="code.html"><img src="../../../../doc/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 100755 index 0000000000..273dada53f --- /dev/null +++ b/doc/html/boostbook/dtd/struct-specialization.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element struct-specialization</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="enumname.html" title="BoostBook element enumname"> +<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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="struct.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="specialization.html" title="BoostBook element specialization">specialization</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3864985"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="enumname.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="struct.html"><img src="../../../../doc/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 100755 index 0000000000..a25fb439c5 --- /dev/null +++ b/doc/html/boostbook/dtd/struct.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element struct</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lib.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3865284"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="struct-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="lib.html"><img src="../../../../doc/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 100755 index 0000000000..774452d870 --- /dev/null +++ b/doc/html/boostbook/dtd/template-arg.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element template-arg</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="throws.html" title="BoostBook element throws"> +<link rel="next" href="globalname.html" title="BoostBook element globalname"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="throws.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="globalname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3859721"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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>pack</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to '1' if this is a pack exapansion.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="throws.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="globalname.html"><img src="../../../../doc/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 100755 index 0000000000..b889d1e309 --- /dev/null +++ b/doc/html/boostbook/dtd/template-nontype-parameter.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element template-nontype-parameter</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="purpose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="default.html" title="BoostBook element default">default</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?) +</div> +<div class="refsection"> +<a name="id3864121"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>pack</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to '1' if the parameter is a parameter pack.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="purpose.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="library.html"><img src="../../../../doc/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 100755 index 0000000000..acbdf2ba70 --- /dev/null +++ b/doc/html/boostbook/dtd/template-type-parameter.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element template-type-parameter</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="destructor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="default.html" title="BoostBook element default">default</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?) +</div> +<div class="refsection"> +<a name="id3855477"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td> +</tr> +<tr> +<td>pack</td> +<td>#IMPLIED</td> +<td>CDATA</td> +<td>Set to '1' if the parameter is a parameter pack.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="destructor.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="description.html"><img src="../../../../doc/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 100755 index 0000000000..bc07594e59 --- /dev/null +++ b/doc/html/boostbook/dtd/template-varargs.html @@ -0,0 +1,95 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element template-varargs</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inherit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="source.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3856680"></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"> +<a name="id3856693"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="inherit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="source.html"><img src="../../../../doc/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 100755 index 0000000000..8c94f4b587 --- /dev/null +++ b/doc/html/boostbook/dtd/template.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element template</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="compile-fail-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template-type-parameter.html" title="BoostBook element template-type-parameter">template-type-parameter</a>| <a class="link" href="template-nontype-parameter.html" title="BoostBook element template-nontype-parameter">template-nontype-parameter</a>| <a class="link" href="template-varargs.html" title="BoostBook element template-varargs">template-varargs</a>)* +</div> +<div class="refsection"> +<a name="id3861247"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="run-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="compile-fail-test.html"><img src="../../../../doc/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 100755 index 0000000000..7c241ecf60 --- /dev/null +++ b/doc/html/boostbook/dtd/testsuite.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element testsuite</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryinfo.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="header.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="compile-test.html" title="BoostBook element compile-test">compile-test</a>| <a class="link" href="link-test.html" title="BoostBook element link-test">link-test</a>| <a class="link" href="run-test.html" title="BoostBook element run-test">run-test</a>| <a class="link" href="compile-fail-test.html" title="BoostBook element compile-fail-test">compile-fail-test</a>| <a class="link" href="link-fail-test.html" title="BoostBook element link-fail-test">link-fail-test</a>| <a class="link" href="run-fail-test.html" title="BoostBook element run-fail-test">run-fail-test</a>)+) +</div> +<div class="refsection"> +<a name="id3866094"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="libraryinfo.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="header.html"><img src="../../../../doc/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 100755 index 0000000000..36741ad38d --- /dev/null +++ b/doc/html/boostbook/dtd/throws.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element throws</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-arg.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3859611"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="union-specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="template-arg.html"><img src="../../../../doc/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 100755 index 0000000000..f8323fd387 --- /dev/null +++ b/doc/html/boostbook/dtd/type.html @@ -0,0 +1,87 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element type</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorydef.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enumvalue.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3863317"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorydef.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enumvalue.html"><img src="../../../../doc/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 100755 index 0000000000..a951749e36 --- /dev/null +++ b/doc/html/boostbook/dtd/typedef.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element typedef</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="static-constant.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="type.html" title="BoostBook element type">type</a>, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?) +</div> +<div class="refsection"> +<a name="id3854831"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="link-fail-test.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="static-constant.html"><img src="../../../../doc/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 100755 index 0000000000..97a20b237e --- /dev/null +++ b/doc/html/boostbook/dtd/union-specialization.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element union-specialization</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="throws.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="specialization.html" title="BoostBook element specialization">specialization</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>?, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3859488"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="specialization.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="throws.html"><img src="../../../../doc/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 100755 index 0000000000..179764e331 --- /dev/null +++ b/doc/html/boostbook/dtd/union.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element union</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="boostbook.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inherit.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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 class="link" href="template.html" title="BoostBook element template">template</a>?, <a class="link" href="inherit.html" title="BoostBook element inherit">inherit</a>*, <a class="link" href="purpose.html" title="BoostBook element purpose">purpose</a>?, <a class="link" href="description.html" title="BoostBook element description">description</a>?, (<a class="link" href="access.html" title="BoostBook element access">access</a>| <a class="link" href="static-constant.html" title="BoostBook element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="BoostBook element typedef">typedef</a>| <a class="link" href="enum.html" title="BoostBook element enum">enum</a>| <a class="link" href="copy-assignment.html" title="BoostBook element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="BoostBook element constructor">constructor</a>| <a class="link" href="destructor.html" title="BoostBook element destructor">destructor</a>| <a class="link" href="method-group.html" title="BoostBook element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="BoostBook element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="BoostBook element function">function</a>| <a class="link" href="method.html" title="BoostBook element method">method</a>| <a class="link" href="overloaded-function.html" title="BoostBook element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="BoostBook element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="BoostBook element data-member">data-member</a>| <a class="link" href="class.html" title="BoostBook element class">class</a>| <a class="link" href="class-specialization.html" title="BoostBook element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="BoostBook element struct">struct</a>| <a class="link" href="struct-specialization.html" title="BoostBook element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="BoostBook element union">union</a>| <a class="link" href="union-specialization.html" title="BoostBook element union-specialization">union-specialization</a>)*) +</div> +<div class="refsection"> +<a name="id3856397"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="boostbook.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="inherit.html"><img src="../../../../doc/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 100755 index 0000000000..2c77e030a1 --- /dev/null +++ b/doc/html/boostbook/dtd/using-class.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element using-class</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="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%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="paramtype.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run-test.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3860424"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="paramtype.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run-test.html"><img src="../../../../doc/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 100755 index 0000000000..310ded408b --- /dev/null +++ b/doc/html/boostbook/dtd/using-namespace.html @@ -0,0 +1,93 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>BoostBook element using-namespace</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../reference.html" title="Reference"> +<link rel="prev" href="librarycategorylist.html" title="BoostBook element librarycategorylist"> +<link rel="next" href="enumname.html" title="BoostBook element enumname"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enumname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<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"> +<a name="id3864569"></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: 2009-10-10 15:53:46 +0100 (Sat, 10 Oct 2009) $ 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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarycategorylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="enumname.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/getting/started.html b/doc/html/boostbook/getting/started.html new file mode 100755 index 0000000000..47bcde378c --- /dev/null +++ b/doc/html/boostbook/getting/started.html @@ -0,0 +1,319 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Getting Started</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../boostbook.html" title="Chapter 36. The BoostBook Documentation Format"> +<link rel="prev" href="../../boostbook.html" title="Chapter 36. The BoostBook Documentation Format"> +<link rel="next" href="../documenting.html" title="Documenting libraries"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../boostbook.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boostbook.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../documenting.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="boostbook.getting.started"></a>Getting Started</h2></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="started.html#boostbook.setup.autounix">Automatic setup for Unix-like systems</a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.manual">Manual setup for all systems</a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.running">Running BoostBook</a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.troubleshooting">Troubleshooting</a></span></dt> +</dl></div> +<p>To use the Boost documentation tools, you will need several tools:</p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"> +<p class="simpara"><span class="command"><strong>xsltproc</strong></span>:</p> +<div class="itemizedlist"><ul class="itemizedlist" type="circle"> +<li class="listitem">Windows with <a href="http://www.cygwin.com/" target="_top">Cygwin</a>: select the libxml2 and libxslt packages.</li> +<li class="listitem">Windows without Cygwin: Download the <a href="http://www.zlatkovic.com/pub/libxml/" target="_top">binary packages</a> + from Igor Zlatkovic. At the very least, you'll need iconv, zlib, libxml2 and libxslt.</li> +<li class="listitem">Mac OS X with Fink: Get the <code class="computeroutput">libxslt</code> package.</li> +<li class="listitem">Mac OS X without Fink: <a href="http://www.zveno.com/open_source/libxml2xslt.html" target="_top">Download the libxslt binaries</a> +</li> +<li class="listitem">Any platform: <a href="http://xmlsoft.org/XSLT/" target="_top">libxslt source</a>.</li> +</ul></div> +</li> +<li class="listitem"> +<p class="simpara"><span class="command"><strong>doxygen</strong></span>:</p> Available from <a href="http://www.doxygen.org" target="_top">http://www.doxygen.org</a> +</li> +</ul></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.setup.autounix"></a>Automatic setup for Unix-like systems</h3></div></div></div> +<p>BoostBook provides a nearly-automatic setup script. Once + you have downloaded and + installed <span class="command"><strong>xsltproc</strong></span>, <span class="command"><strong>doxygen</strong></span>, + and (optionally) <span class="command"><strong>java</strong></span>, the setup script can + download the required DocBook stylesheets, DocBook DTD, and + (when Java is enabled) Apache FOP for PDF output. It will then + configure Boost.Build version 2 to build BoostBook + documentation.</p> +<p>The script requires: <span class="command"><strong>sh</strong></span>, + <span class="command"><strong>curl</strong></span> and <span class="command"><strong>gunzip</strong></span>. + To perform the installation, execute the + script <span class="command"><strong>tools/boostbook/setup_boostbook.sh</strong></span> + from a directory where you would like the resulting XSL, DTD, + and Apache FOP installations to occur. </p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.setup.manual"></a>Manual setup for all systems</h3></div></div></div> +<div class="toc"><dl> +<dt><span class="section"><a href="started.html#boostbook.setup.xsltproc">Configuring <span class="command"><strong>xsltproc</strong></span></a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.docbook">Configuring local DocBook XSL and DTD distributions</a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.doxygen">Configuring Doxygen for Documentation Extraction</a></span></dt> +<dt><span class="section"><a href="started.html#boostbook.setup.fop">Configuring Apache FOP</a></span></dt> +</dl></div> +<p>This section describes how to manually configure Boost + Boost version 2 (BBv@) for BoostBook. If you can use the + automatic setup script, you should. All configuration will + happen in the BBv2 user configuration file, + <code class="filename">user-config.jam</code>. If you do not have a copy + of this file in your home directory, you should copy the one + that resides in <code class="computeroutput">tools/build/v2</code> to your home + directory. Alternatively, you can edit + <code class="filename">tools/build/v2/user-config.jam</code> directly or + a site-wide <code class="filename">site-config.jam</code> file.</p> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boostbook.setup.xsltproc"></a>Configuring <span class="command"><strong>xsltproc</strong></span> +</h4></div></div></div> +<p>To configure <span class="command"><strong>xsltproc</strong></span> manually, you + will need to add a directive to + <code class="filename">user-config.jam</code> telling it where to find + <span class="command"><strong>xsltproc</strong></span>. If the program is in your path, + just add the following line to + <code class="filename">user-config.jam</code>:</p> +<pre class="programlisting">using xsltproc ;</pre> +<p>If <span class="command"><strong>xsltproc</strong></span> is somewhere else, use + this directive, where <code class="computeroutput">XSLTPROC</code> is the full + pathname to <span class="command"><strong>xsltproc</strong></span> (including + <span class="command"><strong>xsltproc</strong></span>):</p> +<pre class="programlisting">using xsltproc : XSLTPROC ;</pre> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boostbook.setup.docbook"></a>Configuring local DocBook XSL and DTD distributions</h4></div></div></div> +<p>This section describes how to configure Boost.Build to + use local copies of the DocBook DTD and XSL stylesheets to + improve processing time. You will first need to download two + packages: + + </p> +<div class="itemizedlist"><ul class="itemizedlist" type="disc"> +<li class="listitem"><p>Norman Walsh's DocBook XSL stylesheets, + available at the <a href="http://docbook.sourceforge.net" target="_top">DocBook sourceforge + site</a>. Extract the DocBook XSL stylesheets to a + directory on your hard disk (which we'll refer to as the + <code class="computeroutput">DOCBOOK_XSL_DIR</code>).</p></li> +<li class="listitem"><p>The DocBook DTD, available as a ZIP archive + at the <a href="http://www.oasis-open.org/docbook/xml/4.2/" target="_top">OASIS + DocBook site</a>. The package is called "DocBook XML + 4.2". Extract the DocBook DTD to a directory on your hard + disk (which we'll refer to as the + <code class="computeroutput">DOCBOOK_DTD_DIR</code>). You will want to extract this + archive in a subdirectory!</p></li> +</ul></div> +<p> + </p> +<p>Add the following directive telling BBv2 where to find + the DocBook DTD and XSL stylesheets:</p> +<pre class="programlisting"># BoostBook configuration +using boostbook + : DOCBOOK_XSL_DIR + : DOCBOOK_DTD_DIR + ;</pre> +<p>Whenever you change this directive, you will need to + remove the <code class="computeroutput">bin.v2</code> directory that BBv2 generates. + This is due to longstanding bug we are trying to fix.</p> +<p>At this point, you should be able to build HTML + documentation for libraries that do not require Doxygen. To + test this, change into the directory <code class="filename">$BOOST_ROOT/libs/function/doc</code> and + run the command <code class="computeroutput">bjam</code>: it should produce HTML + documentation for the Boost.Function library in the + <code class="computeroutput">html</code> subdirectory.</p> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boostbook.setup.doxygen"></a>Configuring Doxygen for Documentation Extraction</h4></div></div></div> +<p>Doxygen is required to build the documentation for + several Boost libraries. You will need a recent version of + <a href="http://www.doxygen.org" target="_top">Doxygen</a> (most of + the 1.3.x and 1.4.x versions will suffice). BBv2 by adding the + following directive to + <code class="filename">user-config.jam</code>:</p> +<pre class="programlisting">using doxygen : DOXYGEN ;</pre> +<p><code class="filename">DOXYGEN</code> should be replaced with the + name of the <span class="command"><strong>doxygen</strong></span> executable (with full + path name). If the right <span class="command"><strong>doxygen</strong></span> executable + can be found via the path, this parameter can be + omitted, e.g.</p> +<pre class="programlisting">using doxygen ;</pre> +<div class="important"><table border="0" summary="Important"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../doc/src/images/important.png"></td> +<th align="left">Important</th> +</tr> +<tr><td align="left" valign="top"><p>The relative order of declarations in + <code class="filename">user-config.jam</code> / + <code class="filename">site-config.jam</code> files is + significant. In particular, the <code class="literal">using + doxygen</code> line should come + <span class="emphasis"><em>after</em></span> the <code class="literal">using + boostbook</code> declaration. + </p></td></tr> +</table></div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boostbook.setup.fop"></a>Configuring Apache FOP</h4></div></div></div> +<p>In order to generate PDF and PostScript output using + Apache FOP, you will need a <a href="http://java.sun.com" target="_top">Java interpreter</a> and <a href="http://xml.apache.org/fop/download.html" target="_top">Apache FOP</a> + (version 0.20.5 is best). Unpack Apache FOP to some + directory. The top level directory of the FOP tool should + contain a main script called <code class="filename">fop.sh</code> on Unix + and <code class="filename">fop.bat</code> on Windows. You need to specify + the location of that script and Java location to + Boost.Build. Add the following to your + <code class="filename">user-config.jam</code> or + <code class="filename">site-config.jam</code>: +</p> +<pre class="programlisting"> +using fop : FOP_COMMAND + : JAVA_HOME + ; +</pre> +<p> replacing + <code class="computeroutput">FOP_COMMAND</code> with the full path to the FOP main script, and + replacing <code class="computeroutput">JAVA_HOME</code> with the directory where Java is + installed. If the <code class="envar">JAVA_HOME</code> environment variable is + already set, you don't need to specify it above. + </p> +<p> + Proper generation of images in PDFs depends on the <a href="http://java.sun.com/products/jimi/#" target="_top">Jimi Image + Library</a>. To get FOP to use Jimi, extract the + <code class="filename">JimiProClasses.zip</code> file from the Jimi SDK + and rename it—if on Windows, to + <code class="filename">jimi-1.0.jar</code>, or if on *nix, to + <code class="filename">JimiProClasses.jar</code>—and place it in the + <code class="filename">lib/</code> subdirectory of your FOP + installation. + </p> +<p>To test PDF generation, switch to the directory <code class="filename">$BOOST_ROOT/libs/function/doc</code> and + execute the command <span class="command"><strong>bjam pdf</strong></span>. In the + absence of any errors, Apache FOP will be executed to transform + the XSL:FO output of DocBook into a PDF file.</p> +</div> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.setup.running"></a>Running BoostBook</h3></div></div></div> +<p>Once BoostBook has been configured, we can build some + documentation. First, change to the directory + <code class="computeroutput">$BOOST_ROOT/doc</code> and remove (or make writable) the + <code class="computeroutput">.html</code> files in + <code class="computeroutput">$BOOST_ROOT/doc/html</code>. Then, run <code class="computeroutput">bjam</code> + to build HTML documentation. You should see several + warnings like these while DocBook documentation is being built + from BoostBook documentation:</p> +<pre class="programlisting">Cannot find function named 'checked_delete' +Cannot find function named 'checked_array_delete' +Cannot find function named 'next'</pre> +<p>These warnings are emitted when the Boost documentation + tools cannot find documentation for functions, methods, or classes + that are referenced in the source, and are not harmful in any + way. Once Boost.Jam has completed its execution, HTML + documentation for Boost will be available in + <code class="computeroutput">$BOOST_ROOT/doc/html</code>. You can also create HTML + documentation in a single (large!) HTML file with the command line + <code class="computeroutput">bjam onehtml</code>, or Unix man pages with the command + line <code class="computeroutput">bjam man</code>. The complete list of output + formats is listed in <a class="xref" href="started.html#boostbook.output.formats" title="Table 36.1. BoostBook Output Formats">Table 36.1, “BoostBook Output Formats”</a>. Several output formats can + be passed to a single invocation of <code class="computeroutput">bjam</code>, e.g., + <code class="computeroutput">bjam html man docbook</code> would generate HTML + (multiple files), man pages, and DocBook documentation.</p> +<div class="table"> +<a name="boostbook.output.formats"></a><p class="title"><b>Table 36.1. BoostBook Output Formats</b></p> +<div class="table-contents"><table class="table" summary="BoostBook Output Formats"> +<colgroup> +<col> +<col> +</colgroup> +<thead><tr> +<th>Format</th> +<th>Description</th> +</tr></thead> +<tbody> +<tr> +<td>html</td> +<td><p>HTML output (multiple files). This is the default</p></td> +</tr> +<tr> +<td>onehtml</td> +<td><p>HTML output in a single HTML file.</p></td> +</tr> +<tr> +<td>man</td> +<td><p>Unix man pages.</p></td> +</tr> +<tr> +<td>pdf</td> +<td><p>PDF. Requires <a href="http://xml.apache.org/fop/index.html" target="_top">Apache FOP</a>.</p></td> +</tr> +<tr> +<td>ps</td> +<td><p>Postscript. Requires <a href="http://xml.apache.org/fop/index.html" target="_top">Apache FOP</a>.</p></td> +</tr> +<tr> +<td>docbook</td> +<td> +<a href="http://www.docbook.org/" target="_top">DocBook</a>.</td> +</tr> +<tr> +<td>fo</td> +<td><a href="http://www.w3.org/TR/xsl/" target="_top">XSL Formatting Objects</a></td> +</tr> +</tbody> +</table></div> +</div> +<br class="table-break"> +</div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.setup.troubleshooting"></a>Troubleshooting</h3></div></div></div> +<p>The Boost documentation tools are still in their early phase of + development, and some things don't work as seamlessly as we would like + them to, yet. In particular, error messages can be somewhat + uninformative at times. If you find yourself in the situation when + you have double checked everything, and yet things still don't work as + expected, consider helping the tools by deleting + <code class="literal">bin.v2</code> build directory. + </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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../../boostbook.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boostbook.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../documenting.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boostbook/together.html b/doc/html/boostbook/together.html new file mode 100755 index 0000000000..493db7ef84 --- /dev/null +++ b/doc/html/boostbook/together.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Bringing Together a BoostBook Document</title> +<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../boostbook.html" title="Chapter 36. The BoostBook Documentation Format"> +<link rel="prev" href="documenting.html" title="Documenting libraries"> +<link rel="next" href="../reference.html" title="Reference"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> +<td align="center"><a href="../../../index.html">Home</a></td> +<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="documenting.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h2 class="title" style="clear: both"> +<a name="boostbook.together"></a>Bringing Together a BoostBook Document</h2></div></div></div> +<div class="toc"><dl><dt><span class="section"><a href="together.html#boostbook.linking">Linking in BoostBook</a></span></dt></dl></div> +<div class="section"> +<div class="titlepage"><div><div><h3 class="title"> +<a name="boostbook.linking"></a>Linking in BoostBook</h3></div></div></div> +<p>How one links to another element in BoostBook depends + greatly on the nature of the element linked and how the link + should appear. There are three general linking elements: + <xref>, <link>, and <ulink>. Additionally, there + are linking elements for referencing specific types of entities, + such as classes (<classname>), functions + (<functionname>), or libraries (<libraryname>).</p> +<p>The <xref> element references elements that have an + <code class="computeroutput">id</code> attribute and a title. The actual link text is + composed from title and type of the element referenced. To link to + a particular ID, create an <xref> element with the + <code class="computeroutput">linkend</code> attribute set to the ID of the intended + target. For instance, this section's ID is + <code class="computeroutput">boostbook.linking</code>, so we create a reference it to + with <code class="computeroutput"><xref linkend="boostbook.linking"/></code>, which + will look like this in the text: <a class="xref" href="together.html#boostbook.linking" title="Linking in BoostBook">the section called “Linking in BoostBook”</a>.</p> +<p>The <link> element references an ID in the same way as + <xref>, except that <link> does not generate any text + for the link, so text must be supplied within the element. For + instance, we can again link to this chapter but this time specify + our own text with <code class="computeroutput"><link + linkend="boostbook.linking">like this</link></code>. This + markup will result in a link to this chapter that looks <a class="link" href="together.html#boostbook.linking" title="Linking in BoostBook">like this</a>.</p> +<p>The <ulink> element references a URL that is outside + of the DocBook document. The <code class="computeroutput">url</code> attribute contains + the URL to link to, and the element data provides the link + text.For instance, we can link to the the Boost web site with + <code class="computeroutput"><ulink + url="http://www.boost.org">Boost</ulink>,</code> which + appears in the document like this: <a href="http://www.boost.org" target="_top">Boost</a>.</p> +<p>In BoostBook, <ulink> supports a custom url schema for + linking to files within the boost distribution. This is formed by + setting the <code class="computeroutput">url</code> attribute to <code class="computeroutput">boost:</code> + followed by the file's path. For example, we can link to the + flyweight library with + <code class="computeroutput"><ulink + url="boost:/libs/flyweight/index.html">Boost.Flyweight</ulink></code>, + which will appear like this: <a href="../../../libs/flyweight/index.html" target="_top">Boost.Flyweight</a>. + This schema is only supported for BoostBook <ulink> elements. + It isn't available for any other elements or in Docbook.</p> +<p>The <classname>, <functionname>, + <methodname>, and <libraryname> link to classes, + functions, methods, and libraries, respectively. The text of each + element gives both the name of the element to link to and the link + text. For instance, we can link to the Function library with + <code class="computeroutput"><libraryname>Function</libraryname></code>, + which results in the following: + <a class="link" href="../function.html" title="Chapter 9. Boost.Function">Function</a>. In cases where the displayed + text is different from the actual name, the <code class="computeroutput">alt</code> + attribute can be specified. For instance, the following XML + element references the <code class="computeroutput"><a class="link" href="../boost/function.html" title="Class template function">boost::function</a></code> + class template but displays the text <code class="computeroutput"><a class="link" href="../boost/function.html" title="Class template function">function</a></code>: <code class="computeroutput"><classname + alt="boost::function">function</classname></code>.</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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. + (See accompanying file LICENSE_1_0.txt or copy at + <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="documenting.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../reference.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |