Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/tools/boostbook/doc/reference.xml @ 30

Last change on this file since 30 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 134.5 KB
Line 
1<?xml version="1.0" standalone="yes"?>
2<!--
3   Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
4 
5   Distributed under the Boost Software License, Version 1.0.
6   (See accompanying file LICENSE_1_0.txt or copy at
7   http://www.boost.org/LICENSE_1_0.txt)
8  -->
9<chapter id="reference">
10  <title>Reference</title>
11  <para>Elements:<itemizedlist spacing="compact"><listitem><simpara><link linkend="boostbook.dtd.boostbook">Element <sgmltag>boostbook</sgmltag> - Defines a BoostBook book</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.class">Element <sgmltag>class</sgmltag> - Declares a class or class template</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.class-specialization">Element <sgmltag>class-specialization</sgmltag> - A specialization (partial or full) of a class template</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.code">Element <sgmltag>code</sgmltag> - Mimics the <sgmltag>code</sgmltag> tag in HTML</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.compile-fail-test">Element <sgmltag>compile-fail-test</sgmltag> - A testcase that should fail to compile</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.compile-test">Element <sgmltag>compile-test</sgmltag> - A testcase that should compile correctly</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.complexity">Element <sgmltag>complexity</sgmltag> - The time/space/etc. complexity of a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.constructor">Element <sgmltag>constructor</sgmltag> - Declares a constructor of the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.copy-assignment">Element <sgmltag>copy-assignment</sgmltag> - Declares a copy-assignment operator</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.data-member">Element <sgmltag>data-member</sgmltag> - Declares a data member of a class</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.default">Element <sgmltag>default</sgmltag> - The default value of a function or template parameter</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.description">Element <sgmltag>description</sgmltag> - Detailed description of a construct</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.destructor">Element <sgmltag>destructor</sgmltag> - Declares a destructor for the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.effects">Element <sgmltag>effects</sgmltag> - Declares the side effects of a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.enum">Element <sgmltag>enum</sgmltag> - Declares an enumeration type</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.enumvalue">Element <sgmltag>enumvalue</sgmltag> - A single value of an enumeration</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.free-function-group">Element <sgmltag>free-function-group</sgmltag> - A set of functions that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.function">Element <sgmltag>function</sgmltag> - Declares a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.functionname">Element <sgmltag>functionname</sgmltag> - References a function with the given name</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.header">Element <sgmltag>header</sgmltag> - Declares a C++ header with the given name</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.if-fails">Element <sgmltag>if-fails</sgmltag> - What it means when a testcase fails</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.inherit">Element <sgmltag>inherit</sgmltag> - Declares a base class of the enclosing class or struct</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.lib">Element <sgmltag>lib</sgmltag> - A library dependency</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.library">Element <sgmltag>library</sgmltag> - Top-level element for a library</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.library-reference">Element <sgmltag>library-reference</sgmltag> - Declares the reference material for a library</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.librarycategory">Element <sgmltag>librarycategory</sgmltag> - Declares that the enclosing library is in this category</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.librarycategorydef">Element <sgmltag>librarycategorydef</sgmltag> - Defines a new library category</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.librarycategorylist">Element <sgmltag>librarycategorylist</sgmltag> - Categorized listing of libraries</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.libraryinfo">Element <sgmltag>libraryinfo</sgmltag> - Provides information about a library</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.librarylist">Element <sgmltag>librarylist</sgmltag> - Placeholder for an alphabetical list of libraries</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.libraryname">Element <sgmltag>libraryname</sgmltag> - References a library of the given name</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.librarypurpose">Element <sgmltag>librarypurpose</sgmltag> - Describes in one short sentence or phrase the purpose of a library</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.link-fail-test">Element <sgmltag>link-fail-test</sgmltag> - Declares a test that should compile but fail to link</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.link-test">Element <sgmltag>link-test</sgmltag> - Declares a test that should compile and link</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.method">Element <sgmltag>method</sgmltag> - Declares a method, i.e., a member function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.method-group">Element <sgmltag>method-group</sgmltag> - A set of methods that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.namespace">Element <sgmltag>namespace</sgmltag> - Declares a namespace</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.notes">Element <sgmltag>notes</sgmltag> - Non-normative notes about a function's semantics</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.overloaded-function">Element <sgmltag>overloaded-function</sgmltag> - An overloaded function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.overloaded-method">Element <sgmltag>overloaded-method</sgmltag> - An overloaded method</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.parameter">Element <sgmltag>parameter</sgmltag> - A function parameter</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.paramtype">Element <sgmltag>paramtype</sgmltag> - The type of a function parameter</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.postconditions">Element <sgmltag>postconditions</sgmltag> - Conditions that must hold after the function returns</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.precondition">Element <sgmltag>precondition</sgmltag> - Conditions that must be met prior to executing a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.programlisting">Element <sgmltag>programlisting</sgmltag> - A sample of program code</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.purpose">Element <sgmltag>purpose</sgmltag> - A short description of an entity's use</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.rationale">Element <sgmltag>rationale</sgmltag> - Describes the rationale for a particular function's design</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.requirement">Element <sgmltag>requirement</sgmltag> - A requirement/property in the Jamfile for a testcase</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.requires">Element <sgmltag>requires</sgmltag> - Declares the requirements of a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.returns">Element <sgmltag>returns</sgmltag> - Description of the return value of a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.run-fail-test">Element <sgmltag>run-fail-test</sgmltag> - A testcase that should compile and link, but fail on execution</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.run-test">Element <sgmltag>run-test</sgmltag> - A testcase that should compile, link, and execute</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.signature">Element <sgmltag>signature</sgmltag> - One signature of an overloaded function or method</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.snippet">Element <sgmltag>snippet</sgmltag> - Pulls in a code snippet from a <sgmltag>programlisting</sgmltag> element</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.source">Element <sgmltag>source</sgmltag> - Defines source code for a test</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.specialization">Element <sgmltag>specialization</sgmltag> - Defines the specialization arguments for a class specialization</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.static-constant">Element <sgmltag>static-constant</sgmltag> - Declares a static constant, e.g., <code>const int foo = 5;</code>.</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.struct">Element <sgmltag>struct</sgmltag> - Declares a C++ struct</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.struct-specialization">Element <sgmltag>struct-specialization</sgmltag> - A specialization (full or partial) of a struct template</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.template">Element <sgmltag>template</sgmltag> - Declares the template parameters of a class or function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.template-arg">Element <sgmltag>template-arg</sgmltag> - A template argument in a specialization</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.template-nontype-parameter">Element <sgmltag>template-nontype-parameter</sgmltag> - A nontype template parameter</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.template-type-parameter">Element <sgmltag>template-type-parameter</sgmltag> - Declares a template type parameter</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.template-varargs">Element <sgmltag>template-varargs</sgmltag> - Declares a variable-length list of template parameters</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.testsuite">Element <sgmltag>testsuite</sgmltag> - Describes a library testsuite</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.throws">Element <sgmltag>throws</sgmltag> - Description of the exceptions thrown by a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.type">Element <sgmltag>type</sgmltag> - The type of an element or return type of a function</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.typedef">Element <sgmltag>typedef</sgmltag> - Declares a typedef</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.union">Element <sgmltag>union</sgmltag> - Declares a C++ union or union template</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.union-specialization">Element <sgmltag>union-specialization</sgmltag> - A specialization (full or partial) of a union template</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.using-class">Element <sgmltag>using-class</sgmltag> - Injects the method and function names of a class into the local scope</link></simpara></listitem><listitem><simpara><link linkend="boostbook.dtd.using-namespace">Element <sgmltag>using-namespace</sgmltag> - Injects the declared names from a namespace into the local scope</link></simpara></listitem></itemizedlist></para>
12  <refentry id="boostbook.dtd.class-specialization">
13    <refmeta>
14      <refentrytitle>
15          BoostBook element <sgmltag>class-specialization</sgmltag></refentrytitle>
16      <manvolnum>9</manvolnum>
17    </refmeta>
18    <refnamediv>
19      <refname>class-specialization</refname>
20      <refpurpose>A specialization (partial or full) of a class template</refpurpose>
21    </refnamediv>
22    <refsynopsisdiv>class-specialization ::=
23  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.specialization">specialization</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
24</refsynopsisdiv>
25    <refsection>
26      <title>Attributes</title>
27      <informaltable>
28        <tgroup cols="4">
29          <thead>
30            <row>
31              <entry>Name</entry>
32              <entry>Type</entry>
33              <entry>Value</entry>
34              <entry>Purpose</entry>
35            </row>
36          </thead>
37          <tbody>
38
39<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
40<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
41<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
42<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
43</tbody>
44        </tgroup>
45      </informaltable>
46    </refsection>
47  </refentry>
48  <refentry id="boostbook.dtd.link-test">
49    <refmeta>
50      <refentrytitle>
51          BoostBook element <sgmltag>link-test</sgmltag></refentrytitle>
52      <manvolnum>9</manvolnum>
53    </refmeta>
54    <refnamediv>
55      <refname>link-test</refname>
56      <refpurpose>Declares a test that should compile and link</refpurpose>
57    </refnamediv>
58    <refsynopsisdiv>link-test ::=
59  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
60</refsynopsisdiv>
61    <refsection>
62      <title>Attributes</title>
63      <informaltable>
64        <tgroup cols="4">
65          <thead>
66            <row>
67              <entry>Name</entry>
68              <entry>Type</entry>
69              <entry>Value</entry>
70              <entry>Purpose</entry>
71            </row>
72          </thead>
73          <tbody>
74
75<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
76<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
77</tbody>
78        </tgroup>
79      </informaltable>
80    </refsection>
81  </refentry>
82  <refentry id="boostbook.dtd.link-fail-test">
83    <refmeta>
84      <refentrytitle>
85          BoostBook element <sgmltag>link-fail-test</sgmltag></refentrytitle>
86      <manvolnum>9</manvolnum>
87    </refmeta>
88    <refnamediv>
89      <refname>link-fail-test</refname>
90      <refpurpose>Declares a test that should compile but fail to link</refpurpose>
91    </refnamediv>
92    <refsynopsisdiv>link-fail-test ::=
93  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
94</refsynopsisdiv>
95    <refsection>
96      <title>Attributes</title>
97      <informaltable>
98        <tgroup cols="4">
99          <thead>
100            <row>
101              <entry>Name</entry>
102              <entry>Type</entry>
103              <entry>Value</entry>
104              <entry>Purpose</entry>
105            </row>
106          </thead>
107          <tbody>
108
109<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
110<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
111</tbody>
112        </tgroup>
113      </informaltable>
114    </refsection>
115  </refentry>
116  <refentry id="boostbook.dtd.typedef">
117    <refmeta>
118      <refentrytitle>
119          BoostBook element <sgmltag>typedef</sgmltag></refentrytitle>
120      <manvolnum>9</manvolnum>
121    </refmeta>
122    <refnamediv>
123      <refname>typedef</refname>
124      <refpurpose>Declares a typedef</refpurpose>
125    </refnamediv>
126    <refsynopsisdiv>typedef ::=
127  (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
128</refsynopsisdiv>
129    <refsection>
130      <title>Attributes</title>
131      <informaltable>
132        <tgroup cols="4">
133          <thead>
134            <row>
135              <entry>Name</entry>
136              <entry>Type</entry>
137              <entry>Value</entry>
138              <entry>Purpose</entry>
139            </row>
140          </thead>
141          <tbody>
142
143<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
144<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
145<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
146<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
147</tbody>
148        </tgroup>
149      </informaltable>
150    </refsection>
151  </refentry>
152  <refentry id="boostbook.dtd.static-constant">
153    <refmeta>
154      <refentrytitle>
155          BoostBook element <sgmltag>static-constant</sgmltag></refentrytitle>
156      <manvolnum>9</manvolnum>
157    </refmeta>
158    <refnamediv>
159      <refname>static-constant</refname>
160      <refpurpose>Declares a static constant, e.g., <code>const int foo = 5;</code>.</refpurpose>
161    </refnamediv>
162    <refsynopsisdiv>static-constant ::=
163  (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.default">default</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
164</refsynopsisdiv>
165    <refsection>
166      <title>Attributes</title>
167      <informaltable>
168        <tgroup cols="4">
169          <thead>
170            <row>
171              <entry>Name</entry>
172              <entry>Type</entry>
173              <entry>Value</entry>
174              <entry>Purpose</entry>
175            </row>
176          </thead>
177          <tbody>
178
179<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
180<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
181<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
182<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
183</tbody>
184        </tgroup>
185      </informaltable>
186    </refsection>
187  </refentry>
188  <refentry id="boostbook.dtd.code">
189    <refmeta>
190      <refentrytitle>
191          BoostBook element <sgmltag>code</sgmltag></refentrytitle>
192      <manvolnum>9</manvolnum>
193    </refmeta>
194    <refnamediv>
195      <refname>code</refname>
196      <refpurpose>Mimics the <sgmltag>code</sgmltag> tag in HTML</refpurpose>
197    </refnamediv>
198    <refsynopsisdiv>code ::=
199  (ANY)
200</refsynopsisdiv>
201    <refsection><title>Description</title>
202  <para>Text within a <sgmltag>code</sgmltag> tag is generally typeset
203  in a different, monospaced font so that it stands out as code. The
204  <sgmltag>code</sgmltag> tag in BoostBook is transformed directly
205  into the <sgmltag>computeroutput</sgmltag> tag in DocBook.</para>
206</refsection>
207    <refsection>
208      <title>Attributes</title>
209      <informaltable>
210        <tgroup cols="4">
211          <thead>
212            <row>
213              <entry>Name</entry>
214              <entry>Type</entry>
215              <entry>Value</entry>
216              <entry>Purpose</entry>
217            </row>
218          </thead>
219          <tbody>
220
221<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
222<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
223<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
224</tbody>
225        </tgroup>
226      </informaltable>
227    </refsection>
228  </refentry>
229  <refentry id="boostbook.dtd.destructor">
230    <refmeta>
231      <refentrytitle>
232          BoostBook element <sgmltag>destructor</sgmltag></refentrytitle>
233      <manvolnum>9</manvolnum>
234    </refmeta>
235    <refnamediv>
236      <refname>destructor</refname>
237      <refpurpose>Declares a destructor for the enclosing class</refpurpose>
238    </refnamediv>
239    <refsynopsisdiv>destructor ::=
240  (<link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
241</refsynopsisdiv>
242    <refsection><title>Description</title>
243  <para>General documentation on functions in BoostBook is provided in
244  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
245  element documentation.</para>
246</refsection>
247    <refsection>
248      <title>Attributes</title>
249      <informaltable>
250        <tgroup cols="4">
251          <thead>
252            <row>
253              <entry>Name</entry>
254              <entry>Type</entry>
255              <entry>Value</entry>
256              <entry>Purpose</entry>
257            </row>
258          </thead>
259          <tbody>
260
261<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
262<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
263<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
264<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
265</tbody>
266        </tgroup>
267      </informaltable>
268    </refsection>
269  </refentry>
270  <refentry id="boostbook.dtd.template-type-parameter">
271    <refmeta>
272      <refentrytitle>
273          BoostBook element <sgmltag>template-type-parameter</sgmltag></refentrytitle>
274      <manvolnum>9</manvolnum>
275    </refmeta>
276    <refnamediv>
277      <refname>template-type-parameter</refname>
278      <refpurpose>Declares a template type parameter</refpurpose>
279    </refnamediv>
280    <refsynopsisdiv>template-type-parameter ::=
281  (<link linkend="boostbook.dtd.default">default</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?)
282</refsynopsisdiv>
283    <refsection>
284      <title>Attributes</title>
285      <informaltable>
286        <tgroup cols="4">
287          <thead>
288            <row>
289              <entry>Name</entry>
290              <entry>Type</entry>
291              <entry>Value</entry>
292              <entry>Purpose</entry>
293            </row>
294          </thead>
295          <tbody>
296
297<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
298<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
299<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
300<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
301</tbody>
302        </tgroup>
303      </informaltable>
304    </refsection>
305  </refentry>
306  <refentry id="boostbook.dtd.description">
307    <refmeta>
308      <refentrytitle>
309          BoostBook element <sgmltag>description</sgmltag></refentrytitle>
310      <manvolnum>9</manvolnum>
311    </refmeta>
312    <refnamediv>
313      <refname>description</refname>
314      <refpurpose>Detailed description of a construct</refpurpose>
315    </refnamediv>
316    <refsynopsisdiv>description ::=
317  (ANY)
318</refsynopsisdiv>
319    <refsection><title>Description</title>
320  <para>Although the context model for this element is
321  <code>ANY</code>, detailed descriptions should contain structured
322  DocBook elements that occur within sections, e.g., paragraphs
323  (<sgmltag>para</sgmltag>, <sgmltag>simpara</sgmltag>), lists
324  (<sgmltag>orderedlist</sgmltag>, <sgmltag>itemizedlist</sgmltag>),
325  tables (<sgmltag>informaltable</sgmltag>, <sgmltag>table</sgmltag>),
326  etc.</para>
327</refsection>
328    <refsection>
329      <title>Attributes</title>
330      <informaltable>
331        <tgroup cols="4">
332          <thead>
333            <row>
334              <entry>Name</entry>
335              <entry>Type</entry>
336              <entry>Value</entry>
337              <entry>Purpose</entry>
338            </row>
339          </thead>
340          <tbody>
341
342<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
343<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
344<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
345</tbody>
346        </tgroup>
347      </informaltable>
348    </refsection>
349  </refentry>
350  <refentry id="boostbook.dtd.librarylist">
351    <refmeta>
352      <refentrytitle>
353          BoostBook element <sgmltag>librarylist</sgmltag></refentrytitle>
354      <manvolnum>9</manvolnum>
355    </refmeta>
356    <refnamediv>
357      <refname>librarylist</refname>
358      <refpurpose>Placeholder for an alphabetical list of libraries</refpurpose>
359    </refnamediv>
360    <refsynopsisdiv>librarylist ::=
361  EMPTY
362</refsynopsisdiv>
363    <refsection><title>Description</title>
364  <para>Developers aren't generally expected to use this element. Its existence is mainly as a placeholder in <filename>boost.xml</filename> for the alphabetical list of libraries.</para>
365</refsection>
366    <refsection>
367      <title>Attributes</title>
368      <informaltable>
369        <tgroup cols="4">
370          <thead>
371            <row>
372              <entry>Name</entry>
373              <entry>Type</entry>
374              <entry>Value</entry>
375              <entry>Purpose</entry>
376            </row>
377          </thead>
378          <tbody>
379
380<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
381<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
382<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
383</tbody>
384        </tgroup>
385      </informaltable>
386    </refsection>
387  </refentry>
388  <refentry id="boostbook.dtd.library-reference">
389    <refmeta>
390      <refentrytitle>
391          BoostBook element <sgmltag>library-reference</sgmltag></refentrytitle>
392      <manvolnum>9</manvolnum>
393    </refmeta>
394    <refnamediv>
395      <refname>library-reference</refname>
396      <refpurpose>Declares the reference material for a library</refpurpose>
397    </refnamediv>
398    <refsynopsisdiv>library-reference ::=
399  (title?, section*, (<link linkend="boostbook.dtd.header">header</link>| <link linkend="boostbook.dtd.library-reference">library-reference</link>)*)
400</refsynopsisdiv>
401    <refsection><title>Description</title>
402  <para>Reference documentation for a library is contained with a
403  &lt;library-reference&gt; element. The &lt;library-reference&gt;
404  element has no attributes, and contains as children only
405  &lt;header&gt; elements.</para>
406
407  <para>The &lt;header&gt; element defines a C++ header file. Within
408  each C++ header file lie the definitions of C++ constructs to be
409  documented. The <code>name</code> attribute of the &lt;header&gt;
410  element gives the name of the header, as one would specify when
411  including the header. For instance, the &lt;library-reference&gt;
412  for the <libraryname>Any</libraryname> library may look like
413  this:</para>
414
415  <programlisting>&lt;library-reference&gt;
416  &lt;header name=&quot;boost/any.hpp&quot;&gt;
417    &lt;!-- C++ constructs in this header --&gt;
418  &lt;/header&gt;
419&lt;/library-reference&gt;</programlisting>
420
421  <para>If the <libraryname>Any</libraryname> library contained
422  multiple headers, we would list them all as children of the
423  &lt;library-reference&gt; element.</para>
424
425  <para><sgmltag>library-reference</sgmltag> elements can be nested,
426  so that reference material can be divided into separate sections
427  that each contain different headers.</para>
428</refsection>
429    <refsection>
430      <title>Attributes</title>
431      <informaltable>
432        <tgroup cols="4">
433          <thead>
434            <row>
435              <entry>Name</entry>
436              <entry>Type</entry>
437              <entry>Value</entry>
438              <entry>Purpose</entry>
439            </row>
440          </thead>
441          <tbody>
442
443<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
444<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
445<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
446</tbody>
447        </tgroup>
448      </informaltable>
449    </refsection>
450  </refentry>
451  <refentry id="boostbook.dtd.boostbook">
452    <refmeta>
453      <refentrytitle>
454          BoostBook element <sgmltag>boostbook</sgmltag></refentrytitle>
455      <manvolnum>9</manvolnum>
456    </refmeta>
457    <refnamediv>
458      <refname>boostbook</refname>
459      <refpurpose>Defines a BoostBook book</refpurpose>
460    </refnamediv>
461    <refsynopsisdiv>boostbook ::=
462  (title, (chapter| <link linkend="boostbook.dtd.library">library</link>)*)
463</refsynopsisdiv>
464    <refsection><title>Description</title>
465  <simpara>This element is the topmost level defined by
466  <filename>boost.xml</filename> for all Boost documentation. It will
467  not generally be used by developers.</simpara>
468</refsection>
469    <refsection>
470      <title>Attributes</title>
471      <informaltable>
472        <tgroup cols="4">
473          <thead>
474            <row>
475              <entry>Name</entry>
476              <entry>Type</entry>
477              <entry>Value</entry>
478              <entry>Purpose</entry>
479            </row>
480          </thead>
481          <tbody>
482
483<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
484<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
485<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
486</tbody>
487        </tgroup>
488      </informaltable>
489    </refsection>
490  </refentry>
491  <refentry id="boostbook.dtd.union">
492    <refmeta>
493      <refentrytitle>
494          BoostBook element <sgmltag>union</sgmltag></refentrytitle>
495      <manvolnum>9</manvolnum>
496    </refmeta>
497    <refnamediv>
498      <refname>union</refname>
499      <refpurpose>Declares a C++ union or union template</refpurpose>
500    </refnamediv>
501    <refsynopsisdiv>union ::=
502  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
503</refsynopsisdiv>
504    <refsection>
505      <title>Attributes</title>
506      <informaltable>
507        <tgroup cols="4">
508          <thead>
509            <row>
510              <entry>Name</entry>
511              <entry>Type</entry>
512              <entry>Value</entry>
513              <entry>Purpose</entry>
514            </row>
515          </thead>
516          <tbody>
517
518<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
519<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
520<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
521<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
522</tbody>
523        </tgroup>
524      </informaltable>
525    </refsection>
526  </refentry>
527  <refentry id="boostbook.dtd.inherit">
528    <refmeta>
529      <refentrytitle>
530          BoostBook element <sgmltag>inherit</sgmltag></refentrytitle>
531      <manvolnum>9</manvolnum>
532    </refmeta>
533    <refnamediv>
534      <refname>inherit</refname>
535      <refpurpose>Declares a base class of the enclosing class or struct</refpurpose>
536    </refnamediv>
537    <refsynopsisdiv>inherit ::=
538  (ANY)
539</refsynopsisdiv>
540    <refsection><title>Description</title>
541  <para>This element contains the name of the class inherited. The
542  content model is free-form, as the inherited class may be an
543  instantiation of a template and may have markup in it (e.g.,
544  <sgmltag>classname</sgmltag> tags).</para>
545</refsection>
546    <refsection>
547      <title>Attributes</title>
548      <informaltable>
549        <tgroup cols="4">
550          <thead>
551            <row>
552              <entry>Name</entry>
553              <entry>Type</entry>
554              <entry>Value</entry>
555              <entry>Purpose</entry>
556            </row>
557          </thead>
558          <tbody>
559
560<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
561<row><entry>access</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry/></row>
562<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
563<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
564</tbody>
565        </tgroup>
566      </informaltable>
567    </refsection>
568  </refentry>
569  <refentry id="boostbook.dtd.template-varargs">
570    <refmeta>
571      <refentrytitle>
572          BoostBook element <sgmltag>template-varargs</sgmltag></refentrytitle>
573      <manvolnum>9</manvolnum>
574    </refmeta>
575    <refnamediv>
576      <refname>template-varargs</refname>
577      <refpurpose>Declares a variable-length list of template parameters</refpurpose>
578    </refnamediv>
579    <refsynopsisdiv>template-varargs ::=
580  EMPTY
581</refsynopsisdiv>
582    <refsection><title>Description</title>
583  <para>Variable-length template parameter lists are not allowed in
584  C++, but because they are sometimes needed in documentation they are
585  allowed in BoostBook. This element generally expands to &quot;...&quot; and
586  can be used anywhere any other template parameter can be
587  used.</para>
588</refsection>
589    <refsection>
590      <title>Attributes</title>
591      <informaltable>
592        <tgroup cols="4">
593          <thead>
594            <row>
595              <entry>Name</entry>
596              <entry>Type</entry>
597              <entry>Value</entry>
598              <entry>Purpose</entry>
599            </row>
600          </thead>
601          <tbody>
602
603<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
604<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
605<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
606</tbody>
607        </tgroup>
608      </informaltable>
609    </refsection>
610  </refentry>
611  <refentry id="boostbook.dtd.source">
612    <refmeta>
613      <refentrytitle>
614          BoostBook element <sgmltag>source</sgmltag></refentrytitle>
615      <manvolnum>9</manvolnum>
616    </refmeta>
617    <refnamediv>
618      <refname>source</refname>
619      <refpurpose>Defines source code for a test</refpurpose>
620    </refnamediv>
621    <refsynopsisdiv>source ::=
622  (#PCDATA| <link linkend="boostbook.dtd.snippet">snippet</link>)*
623</refsynopsisdiv>
624    <refsection><title>Description</title>
625  <para>This element will contain the source code for a testcase that
626  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:
627
628    <programlisting>&lt;![CDATA[
629&lt;your program text here: no escaping needed!&gt;
630]]&gt;</programlisting>
631  </para>
632
633  <para>In addition to CDATA sections, code snippets can be pulled in
634  from <sgmltag>programlisting</sgmltag> elements using the <link linkend="boostbook.dtd.snippet"><sgmltag>snippet</sgmltag></link>
635  element.</para>
636</refsection>
637  </refentry>
638  <refentry id="boostbook.dtd.function">
639    <refmeta>
640      <refentrytitle>
641          BoostBook element <sgmltag>function</sgmltag></refentrytitle>
642      <manvolnum>9</manvolnum>
643    </refmeta>
644    <refnamediv>
645      <refname>function</refname>
646      <refpurpose>Declares a function</refpurpose>
647    </refnamediv>
648    <refsynopsisdiv>function ::=
649  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.parameter">parameter</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
650</refsynopsisdiv>
651    <refsection><title>Description</title>
652  <para>BoostBook functions are documented by specifying the
653  function's interface (e.g., its C++ signature) and its
654  behavior. Constructors, destructors, member functions, and free
655  functions all use the same documentation method, although the
656  top-level tags differ.</para>
657   
658  <para>The behavior of functions in BoostBook is documenting using a
659  style similar to that of the C++ standard, with clauses describing
660  the requirements, effects, postconditions, exception behavior, and
661  return values of functions.</para>
662
663  <para>The following example illustrates some constructors and a
664  destructor for <classname>boost::any</classname>. Note that one of
665  the constructors takes a single parameter whose name is &quot;other&quot; and
666  whose type, <code>const any&amp;</code> is contained in the
667  &lt;paramtype&gt; element; any number of parameters may be specified
668  in this way.</para>
669
670  <programlisting>&lt;class name=&quot;any&quot;&gt;
671  &lt;constructor&gt;
672    &lt;postconditions&gt;&lt;para&gt;&lt;this-&gt;empty()&gt;&lt;/para&gt;&lt;/postconditions&gt;
673  &lt;/constructor&gt;
674
675  &lt;constructor&gt;
676    &lt;parameter name=&quot;other&quot;&gt;
677      &lt;paramtype&gt;const &lt;classname&gt;any&lt;/classname&gt;&amp;amp;&lt;/paramtype&gt;
678    &lt;/parameter&gt;
679
680    &lt;effects&gt;
681      &lt;simpara&gt; Copy constructor that copies
682        content of &lt;code&gt;other&lt;/code&gt; into the new instance,
683        so that any content is equivalent in both type and value to the
684        content of &lt;code&gt;other&lt;/code&gt;, or empty if
685        &lt;code&gt;other&lt;/code&gt; is
686        empty.
687      &lt;/simpara&gt;
688    &lt;/effects&gt;
689
690    &lt;throws&gt;
691      &lt;simpara&gt;May fail with a
692        &lt;classname&gt;std::bad_alloc&lt;/classname&gt; exception or any
693        exceptions arising from the copy constructor of the
694        contained type.
695      &lt;/simpara&gt;
696    &lt;/throws&gt;
697  &lt;/constructor&gt;
698
699  &lt;destructor&gt;
700     &lt;effects&gt;&lt;simpara&gt;Releases any and all resources used in
701     management of instance.&lt;/simpara&gt;&lt;/effects&gt;
702
703     &lt;throws&gt;&lt;simpara&gt;Nothing.&lt;/simpara&gt;&lt;/throws&gt;
704  &lt;/destructor&gt;
705&lt;/class&gt;</programlisting>
706</refsection>
707    <refsection>
708      <title>Attributes</title>
709      <informaltable>
710        <tgroup cols="4">
711          <thead>
712            <row>
713              <entry>Name</entry>
714              <entry>Type</entry>
715              <entry>Value</entry>
716              <entry>Purpose</entry>
717            </row>
718          </thead>
719          <tbody>
720
721<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
722<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
723<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
724<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
725<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
726</tbody>
727        </tgroup>
728      </informaltable>
729    </refsection>
730  </refentry>
731  <refentry id="boostbook.dtd.postconditions">
732    <refmeta>
733      <refentrytitle>
734          BoostBook element <sgmltag>postconditions</sgmltag></refentrytitle>
735      <manvolnum>9</manvolnum>
736    </refmeta>
737    <refnamediv>
738      <refname>postconditions</refname>
739      <refpurpose>Conditions that must hold after the function returns</refpurpose>
740    </refnamediv>
741    <refsynopsisdiv>postconditions ::=
742  (ANY)
743</refsynopsisdiv>
744    <refsection>
745      <title>Attributes</title>
746      <informaltable>
747        <tgroup cols="4">
748          <thead>
749            <row>
750              <entry>Name</entry>
751              <entry>Type</entry>
752              <entry>Value</entry>
753              <entry>Purpose</entry>
754            </row>
755          </thead>
756          <tbody>
757
758<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
759<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
760<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
761</tbody>
762        </tgroup>
763      </informaltable>
764    </refsection>
765  </refentry>
766  <refentry id="boostbook.dtd.compile-test">
767    <refmeta>
768      <refentrytitle>
769          BoostBook element <sgmltag>compile-test</sgmltag></refentrytitle>
770      <manvolnum>9</manvolnum>
771    </refmeta>
772    <refnamediv>
773      <refname>compile-test</refname>
774      <refpurpose>A testcase that should compile correctly</refpurpose>
775    </refnamediv>
776    <refsynopsisdiv>compile-test ::=
777  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
778</refsynopsisdiv>
779    <refsection>
780      <title>Attributes</title>
781      <informaltable>
782        <tgroup cols="4">
783          <thead>
784            <row>
785              <entry>Name</entry>
786              <entry>Type</entry>
787              <entry>Value</entry>
788              <entry>Purpose</entry>
789            </row>
790          </thead>
791          <tbody>
792
793<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
794<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
795</tbody>
796        </tgroup>
797      </informaltable>
798    </refsection>
799  </refentry>
800  <refentry id="boostbook.dtd.method">
801    <refmeta>
802      <refentrytitle>
803          BoostBook element <sgmltag>method</sgmltag></refentrytitle>
804      <manvolnum>9</manvolnum>
805    </refmeta>
806    <refnamediv>
807      <refname>method</refname>
808      <refpurpose>Declares a method, i.e., a member function</refpurpose>
809    </refnamediv>
810    <refsynopsisdiv>method ::=
811  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.parameter">parameter</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
812</refsynopsisdiv>
813    <refsection><title>Description</title>
814  <para>General documentation on functions in BoostBook is provided in
815  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
816  element documentation.</para>
817</refsection>
818    <refsection>
819      <title>Attributes</title>
820      <informaltable>
821        <tgroup cols="4">
822          <thead>
823            <row>
824              <entry>Name</entry>
825              <entry>Type</entry>
826              <entry>Value</entry>
827              <entry>Purpose</entry>
828            </row>
829          </thead>
830          <tbody>
831
832<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
833<row><entry>cv</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>cv-qualifiers for this method, e.g., const volatile</entry></row>
834<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
835<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
836<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
837<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
838</tbody>
839        </tgroup>
840      </informaltable>
841    </refsection>
842  </refentry>
843  <refentry id="boostbook.dtd.snippet">
844    <refmeta>
845      <refentrytitle>
846          BoostBook element <sgmltag>snippet</sgmltag></refentrytitle>
847      <manvolnum>9</manvolnum>
848    </refmeta>
849    <refnamediv>
850      <refname>snippet</refname>
851      <refpurpose>Pulls in a code snippet from a <sgmltag>programlisting</sgmltag> element</refpurpose>
852    </refnamediv>
853    <refsynopsisdiv>snippet ::=
854  EMPTY
855</refsynopsisdiv>
856    <refsection>
857      <title>Attributes</title>
858      <informaltable>
859        <tgroup cols="4">
860          <thead>
861            <row>
862              <entry>Name</entry>
863              <entry>Type</entry>
864              <entry>Value</entry>
865              <entry>Purpose</entry>
866            </row>
867          </thead>
868          <tbody>
869
870<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the <sgmltag>programlisting</sgmltag> element to insert</entry></row>
871</tbody>
872        </tgroup>
873      </informaltable>
874    </refsection>
875  </refentry>
876  <refentry id="boostbook.dtd.constructor">
877    <refmeta>
878      <refentrytitle>
879          BoostBook element <sgmltag>constructor</sgmltag></refentrytitle>
880      <manvolnum>9</manvolnum>
881    </refmeta>
882    <refnamediv>
883      <refname>constructor</refname>
884      <refpurpose>Declares a constructor of the enclosing class</refpurpose>
885    </refnamediv>
886    <refsynopsisdiv>constructor ::=
887  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.parameter">parameter</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
888</refsynopsisdiv>
889    <refsection><title>Description</title>
890  <para>General documentation on functions in BoostBook is provided in
891  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
892  element documentation.</para>
893</refsection>
894    <refsection>
895      <title>Attributes</title>
896      <informaltable>
897        <tgroup cols="4">
898          <thead>
899            <row>
900              <entry>Name</entry>
901              <entry>Type</entry>
902              <entry>Value</entry>
903              <entry>Purpose</entry>
904            </row>
905          </thead>
906          <tbody>
907
908<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
909<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
910<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
911<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
912</tbody>
913        </tgroup>
914      </informaltable>
915    </refsection>
916  </refentry>
917  <refentry id="boostbook.dtd.namespace">
918    <refmeta>
919      <refentrytitle>
920          BoostBook element <sgmltag>namespace</sgmltag></refentrytitle>
921      <manvolnum>9</manvolnum>
922    </refmeta>
923    <refnamediv>
924      <refname>namespace</refname>
925      <refpurpose>Declares a namespace</refpurpose>
926    </refnamediv>
927    <refsynopsisdiv>namespace ::=
928  (<link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.namespace">namespace</link>)*
929</refsynopsisdiv>
930    <refsection><title>Description</title>
931  <para>BoostBook namespaces are declared via the &lt;namespace&gt;
932  element. As in C++, namespaces can be nested and contain other C++
933  constructs, such as classes or functions. The <code>name</code>
934  attribute of a &lt;namespace&gt; element gives the namespace name
935  (e.g., &quot;boost&quot;). The <libraryname>Any</libraryname> library is
936  defined entirely within namespace boost by:</para>
937
938  <programlisting>&lt;library-reference&gt;
939  &lt;header name=&quot;boost/any.hpp&quot;&gt;
940    &lt;namespace name=&quot;boost&quot;&gt; 
941      &lt;!-- C++ constructs in the boost namespace --&gt;
942    &lt;/namespace&gt;
943  &lt;/header&gt;
944&lt;/library-reference&gt;</programlisting>
945</refsection>
946    <refsection>
947      <title>Attributes</title>
948      <informaltable>
949        <tgroup cols="4">
950          <thead>
951            <row>
952              <entry>Name</entry>
953              <entry>Type</entry>
954              <entry>Value</entry>
955              <entry>Purpose</entry>
956            </row>
957          </thead>
958          <tbody>
959
960<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
961<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
962<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
963<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
964</tbody>
965        </tgroup>
966      </informaltable>
967    </refsection>
968  </refentry>
969  <refentry id="boostbook.dtd.if-fails">
970    <refmeta>
971      <refentrytitle>
972          BoostBook element <sgmltag>if-fails</sgmltag></refentrytitle>
973      <manvolnum>9</manvolnum>
974    </refmeta>
975    <refnamediv>
976      <refname>if-fails</refname>
977      <refpurpose>What it means when a testcase fails</refpurpose>
978    </refnamediv>
979    <refsynopsisdiv>if-fails ::=
980  (ANY)
981</refsynopsisdiv>
982    <refsection><title>Description</title>
983  <para>
984    Describes to the user the effect a certain failing testcase will
985    have on the usefulness of a library. This field is useful in cases
986    where a failed testcase does not mean that the library won't be
987    useful, but may mean that certain library features will not be
988    available.
989  </para>
990</refsection>
991  </refentry>
992  <refentry id="boostbook.dtd.free-function-group">
993    <refmeta>
994      <refentrytitle>
995          BoostBook element <sgmltag>free-function-group</sgmltag></refentrytitle>
996      <manvolnum>9</manvolnum>
997    </refmeta>
998    <refnamediv>
999      <refname>free-function-group</refname>
1000      <refpurpose>A set of functions that are grouped together under one name</refpurpose>
1001    </refnamediv>
1002    <refsynopsisdiv>free-function-group ::=
1003  (<link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>)*
1004</refsynopsisdiv>
1005    <refsection>
1006      <title>Attributes</title>
1007      <informaltable>
1008        <tgroup cols="4">
1009          <thead>
1010            <row>
1011              <entry>Name</entry>
1012              <entry>Type</entry>
1013              <entry>Value</entry>
1014              <entry>Purpose</entry>
1015            </row>
1016          </thead>
1017          <tbody>
1018
1019<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1020<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1021<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1022<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1023</tbody>
1024        </tgroup>
1025      </informaltable>
1026    </refsection>
1027  </refentry>
1028  <refentry id="boostbook.dtd.functionname">
1029    <refmeta>
1030      <refentrytitle>
1031          BoostBook element <sgmltag>functionname</sgmltag></refentrytitle>
1032      <manvolnum>9</manvolnum>
1033    </refmeta>
1034    <refnamediv>
1035      <refname>functionname</refname>
1036      <refpurpose>References a function with the given name</refpurpose>
1037    </refnamediv>
1038    <refsynopsisdiv>functionname ::=
1039  (#PCDATA)
1040</refsynopsisdiv>
1041    <refsection><title>Description</title>
1042  <para>If a function (or overloaded function) with the given,
1043  possibly-qualified name is found, this generates a link to that
1044  function. Lookups obey currently-active <link linkend="boostbook.dtd.using-class"><sgmltag>using-class</sgmltag></link>
1045  and <link linkend="boostbook.dtd.using-namespace"><sgmltag>using-namespace</sgmltag></link>
1046  directives to aid in the search, along with searching within the
1047  current scope.</para>
1048</refsection>
1049    <refsection>
1050      <title>Attributes</title>
1051      <informaltable>
1052        <tgroup cols="4">
1053          <thead>
1054            <row>
1055              <entry>Name</entry>
1056              <entry>Type</entry>
1057              <entry>Value</entry>
1058              <entry>Purpose</entry>
1059            </row>
1060          </thead>
1061          <tbody>
1062
1063<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1064<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1065<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1066</tbody>
1067        </tgroup>
1068      </informaltable>
1069    </refsection>
1070  </refentry>
1071  <refentry id="boostbook.dtd.librarycategory">
1072    <refmeta>
1073      <refentrytitle>
1074          BoostBook element <sgmltag>librarycategory</sgmltag></refentrytitle>
1075      <manvolnum>9</manvolnum>
1076    </refmeta>
1077    <refnamediv>
1078      <refname>librarycategory</refname>
1079      <refpurpose>Declares that the enclosing library is in this category</refpurpose>
1080    </refnamediv>
1081    <refsynopsisdiv>librarycategory ::=
1082  (#PCDATA)
1083</refsynopsisdiv>
1084    <refsection>
1085      <title>Attributes</title>
1086      <informaltable>
1087        <tgroup cols="4">
1088          <thead>
1089            <row>
1090              <entry>Name</entry>
1091              <entry>Type</entry>
1092              <entry>Value</entry>
1093              <entry>Purpose</entry>
1094            </row>
1095          </thead>
1096          <tbody>
1097
1098<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1099<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1100<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1101<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1102</tbody>
1103        </tgroup>
1104      </informaltable>
1105    </refsection>
1106  </refentry>
1107  <refentry id="boostbook.dtd.notes">
1108    <refmeta>
1109      <refentrytitle>
1110          BoostBook element <sgmltag>notes</sgmltag></refentrytitle>
1111      <manvolnum>9</manvolnum>
1112    </refmeta>
1113    <refnamediv>
1114      <refname>notes</refname>
1115      <refpurpose>Non-normative notes about a function's semantics</refpurpose>
1116    </refnamediv>
1117    <refsynopsisdiv>notes ::=
1118  (ANY)
1119</refsynopsisdiv>
1120    <refsection>
1121      <title>Attributes</title>
1122      <informaltable>
1123        <tgroup cols="4">
1124          <thead>
1125            <row>
1126              <entry>Name</entry>
1127              <entry>Type</entry>
1128              <entry>Value</entry>
1129              <entry>Purpose</entry>
1130            </row>
1131          </thead>
1132          <tbody>
1133
1134<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1135<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1136<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1137</tbody>
1138        </tgroup>
1139      </informaltable>
1140    </refsection>
1141  </refentry>
1142  <refentry id="boostbook.dtd.data-member">
1143    <refmeta>
1144      <refentrytitle>
1145          BoostBook element <sgmltag>data-member</sgmltag></refentrytitle>
1146      <manvolnum>9</manvolnum>
1147    </refmeta>
1148    <refnamediv>
1149      <refname>data-member</refname>
1150      <refpurpose>Declares a data member of a class</refpurpose>
1151    </refnamediv>
1152    <refsynopsisdiv>data-member ::=
1153  (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
1154</refsynopsisdiv>
1155    <refsection>
1156      <title>Attributes</title>
1157      <informaltable>
1158        <tgroup cols="4">
1159          <thead>
1160            <row>
1161              <entry>Name</entry>
1162              <entry>Type</entry>
1163              <entry>Value</entry>
1164              <entry>Purpose</entry>
1165            </row>
1166          </thead>
1167          <tbody>
1168
1169<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1170<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1171<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1172<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1173</tbody>
1174        </tgroup>
1175      </informaltable>
1176    </refsection>
1177  </refentry>
1178  <refentry id="boostbook.dtd.specialization">
1179    <refmeta>
1180      <refentrytitle>
1181          BoostBook element <sgmltag>specialization</sgmltag></refentrytitle>
1182      <manvolnum>9</manvolnum>
1183    </refmeta>
1184    <refnamediv>
1185      <refname>specialization</refname>
1186      <refpurpose>Defines the specialization arguments for a class specialization</refpurpose>
1187    </refnamediv>
1188    <refsynopsisdiv>specialization ::=
1189  (<link linkend="boostbook.dtd.template-arg">template-arg</link>)*
1190</refsynopsisdiv>
1191    <refsection>
1192      <title>Attributes</title>
1193      <informaltable>
1194        <tgroup cols="4">
1195          <thead>
1196            <row>
1197              <entry>Name</entry>
1198              <entry>Type</entry>
1199              <entry>Value</entry>
1200              <entry>Purpose</entry>
1201            </row>
1202          </thead>
1203          <tbody>
1204
1205<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1206<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1207<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1208</tbody>
1209        </tgroup>
1210      </informaltable>
1211    </refsection>
1212  </refentry>
1213  <refentry id="boostbook.dtd.union-specialization">
1214    <refmeta>
1215      <refentrytitle>
1216          BoostBook element <sgmltag>union-specialization</sgmltag></refentrytitle>
1217      <manvolnum>9</manvolnum>
1218    </refmeta>
1219    <refnamediv>
1220      <refname>union-specialization</refname>
1221      <refpurpose>A specialization (full or partial) of a union template</refpurpose>
1222    </refnamediv>
1223    <refsynopsisdiv>union-specialization ::=
1224  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.specialization">specialization</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
1225</refsynopsisdiv>
1226    <refsection>
1227      <title>Attributes</title>
1228      <informaltable>
1229        <tgroup cols="4">
1230          <thead>
1231            <row>
1232              <entry>Name</entry>
1233              <entry>Type</entry>
1234              <entry>Value</entry>
1235              <entry>Purpose</entry>
1236            </row>
1237          </thead>
1238          <tbody>
1239
1240<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1241<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1242<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1243<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1244</tbody>
1245        </tgroup>
1246      </informaltable>
1247    </refsection>
1248  </refentry>
1249  <refentry id="boostbook.dtd.throws">
1250    <refmeta>
1251      <refentrytitle>
1252          BoostBook element <sgmltag>throws</sgmltag></refentrytitle>
1253      <manvolnum>9</manvolnum>
1254    </refmeta>
1255    <refnamediv>
1256      <refname>throws</refname>
1257      <refpurpose>Description of the exceptions thrown by a function</refpurpose>
1258    </refnamediv>
1259    <refsynopsisdiv>throws ::=
1260  (ANY)
1261</refsynopsisdiv>
1262    <refsection>
1263      <title>Attributes</title>
1264      <informaltable>
1265        <tgroup cols="4">
1266          <thead>
1267            <row>
1268              <entry>Name</entry>
1269              <entry>Type</entry>
1270              <entry>Value</entry>
1271              <entry>Purpose</entry>
1272            </row>
1273          </thead>
1274          <tbody>
1275
1276<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1277<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1278<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1279</tbody>
1280        </tgroup>
1281      </informaltable>
1282    </refsection>
1283  </refentry>
1284  <refentry id="boostbook.dtd.template-arg">
1285    <refmeta>
1286      <refentrytitle>
1287          BoostBook element <sgmltag>template-arg</sgmltag></refentrytitle>
1288      <manvolnum>9</manvolnum>
1289    </refmeta>
1290    <refnamediv>
1291      <refname>template-arg</refname>
1292      <refpurpose>A template argument in a specialization</refpurpose>
1293    </refnamediv>
1294    <refsynopsisdiv>template-arg ::=
1295  (ANY)
1296</refsynopsisdiv>
1297    <refsection>
1298      <title>Attributes</title>
1299      <informaltable>
1300        <tgroup cols="4">
1301          <thead>
1302            <row>
1303              <entry>Name</entry>
1304              <entry>Type</entry>
1305              <entry>Value</entry>
1306              <entry>Purpose</entry>
1307            </row>
1308          </thead>
1309          <tbody>
1310
1311<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1312<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1313<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1314</tbody>
1315        </tgroup>
1316      </informaltable>
1317    </refsection>
1318  </refentry>
1319  <refentry id="boostbook.dtd.method-group">
1320    <refmeta>
1321      <refentrytitle>
1322          BoostBook element <sgmltag>method-group</sgmltag></refentrytitle>
1323      <manvolnum>9</manvolnum>
1324    </refmeta>
1325    <refnamediv>
1326      <refname>method-group</refname>
1327      <refpurpose>A set of methods that are grouped together under one name</refpurpose>
1328    </refnamediv>
1329    <refsynopsisdiv>method-group ::=
1330  (<link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>)*
1331</refsynopsisdiv>
1332    <refsection>
1333      <title>Attributes</title>
1334      <informaltable>
1335        <tgroup cols="4">
1336          <thead>
1337            <row>
1338              <entry>Name</entry>
1339              <entry>Type</entry>
1340              <entry>Value</entry>
1341              <entry>Purpose</entry>
1342            </row>
1343          </thead>
1344          <tbody>
1345
1346<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1347<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1348<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1349<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1350</tbody>
1351        </tgroup>
1352      </informaltable>
1353    </refsection>
1354  </refentry>
1355  <refentry id="boostbook.dtd.requirement">
1356    <refmeta>
1357      <refentrytitle>
1358          BoostBook element <sgmltag>requirement</sgmltag></refentrytitle>
1359      <manvolnum>9</manvolnum>
1360    </refmeta>
1361    <refnamediv>
1362      <refname>requirement</refname>
1363      <refpurpose>A requirement/property in the Jamfile for a testcase</refpurpose>
1364    </refnamediv>
1365    <refsynopsisdiv>requirement ::=
1366  (#PCDATA)
1367</refsynopsisdiv>
1368    <refsection><title>Description</title>
1369  <para>A requirement is part of the dependencies of a target in a
1370  Jamfile. The <code>name</code> attribute of a requirement element
1371  gives the name of the Boost.Build feature and the content of the
1372  requirement gives the value of that feature. A requirement such as
1373  <code>&lt;includes&gt;foo.hpp</code> would be encoded as
1374  <code>&lt;requirement
1375  name=&quot;includes&quot;&gt;foo.hpp&lt;/requirement&gt;</code>.</para>
1376</refsection>
1377    <refsection>
1378      <title>Attributes</title>
1379      <informaltable>
1380        <tgroup cols="4">
1381          <thead>
1382            <row>
1383              <entry>Name</entry>
1384              <entry>Type</entry>
1385              <entry>Value</entry>
1386              <entry>Purpose</entry>
1387            </row>
1388          </thead>
1389          <tbody>
1390
1391<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1392</tbody>
1393        </tgroup>
1394      </informaltable>
1395    </refsection>
1396  </refentry>
1397  <refentry id="boostbook.dtd.precondition">
1398    <refmeta>
1399      <refentrytitle>
1400          BoostBook element <sgmltag>precondition</sgmltag></refentrytitle>
1401      <manvolnum>9</manvolnum>
1402    </refmeta>
1403    <refnamediv>
1404      <refname>precondition</refname>
1405      <refpurpose>Conditions that must be met prior to executing a function</refpurpose>
1406    </refnamediv>
1407    <refsynopsisdiv>precondition ::=
1408  (ANY)
1409</refsynopsisdiv>
1410    <refsection>
1411      <title>Attributes</title>
1412      <informaltable>
1413        <tgroup cols="4">
1414          <thead>
1415            <row>
1416              <entry>Name</entry>
1417              <entry>Type</entry>
1418              <entry>Value</entry>
1419              <entry>Purpose</entry>
1420            </row>
1421          </thead>
1422          <tbody>
1423
1424<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1425<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1426<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1427</tbody>
1428        </tgroup>
1429      </informaltable>
1430    </refsection>
1431  </refentry>
1432  <refentry id="boostbook.dtd.paramtype">
1433    <refmeta>
1434      <refentrytitle>
1435          BoostBook element <sgmltag>paramtype</sgmltag></refentrytitle>
1436      <manvolnum>9</manvolnum>
1437    </refmeta>
1438    <refnamediv>
1439      <refname>paramtype</refname>
1440      <refpurpose>The type of a function parameter</refpurpose>
1441    </refnamediv>
1442    <refsynopsisdiv>paramtype ::=
1443  (ANY)
1444</refsynopsisdiv>
1445    <refsection>
1446      <title>Attributes</title>
1447      <informaltable>
1448        <tgroup cols="4">
1449          <thead>
1450            <row>
1451              <entry>Name</entry>
1452              <entry>Type</entry>
1453              <entry>Value</entry>
1454              <entry>Purpose</entry>
1455            </row>
1456          </thead>
1457          <tbody>
1458
1459<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1460<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1461<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1462</tbody>
1463        </tgroup>
1464      </informaltable>
1465    </refsection>
1466  </refentry>
1467  <refentry id="boostbook.dtd.using-class">
1468    <refmeta>
1469      <refentrytitle>
1470          BoostBook element <sgmltag>using-class</sgmltag></refentrytitle>
1471      <manvolnum>9</manvolnum>
1472    </refmeta>
1473    <refnamediv>
1474      <refname>using-class</refname>
1475      <refpurpose>Injects the method and function names of a class into the local scope</refpurpose>
1476    </refnamediv>
1477    <refsynopsisdiv>using-class ::=
1478  EMPTY
1479</refsynopsisdiv>
1480    <refsection>
1481      <title>Attributes</title>
1482      <informaltable>
1483        <tgroup cols="4">
1484          <thead>
1485            <row>
1486              <entry>Name</entry>
1487              <entry>Type</entry>
1488              <entry>Value</entry>
1489              <entry>Purpose</entry>
1490            </row>
1491          </thead>
1492          <tbody>
1493
1494<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1495<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1496<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1497<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1498</tbody>
1499        </tgroup>
1500      </informaltable>
1501    </refsection>
1502  </refentry>
1503  <refentry id="boostbook.dtd.run-test">
1504    <refmeta>
1505      <refentrytitle>
1506          BoostBook element <sgmltag>run-test</sgmltag></refentrytitle>
1507      <manvolnum>9</manvolnum>
1508    </refmeta>
1509    <refnamediv>
1510      <refname>run-test</refname>
1511      <refpurpose>A testcase that should compile, link, and execute</refpurpose>
1512    </refnamediv>
1513    <refsynopsisdiv>run-test ::=
1514  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
1515</refsynopsisdiv>
1516    <refsection>
1517      <title>Attributes</title>
1518      <informaltable>
1519        <tgroup cols="4">
1520          <thead>
1521            <row>
1522              <entry>Name</entry>
1523              <entry>Type</entry>
1524              <entry>Value</entry>
1525              <entry>Purpose</entry>
1526            </row>
1527          </thead>
1528          <tbody>
1529
1530<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
1531<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1532</tbody>
1533        </tgroup>
1534      </informaltable>
1535    </refsection>
1536  </refentry>
1537  <refentry id="boostbook.dtd.librarypurpose">
1538    <refmeta>
1539      <refentrytitle>
1540          BoostBook element <sgmltag>librarypurpose</sgmltag></refentrytitle>
1541      <manvolnum>9</manvolnum>
1542    </refmeta>
1543    <refnamediv>
1544      <refname>librarypurpose</refname>
1545      <refpurpose>Describes in one short sentence or phrase the purpose of a library</refpurpose>
1546    </refnamediv>
1547    <refsynopsisdiv>librarypurpose ::=
1548  (#PCDATA| <link linkend="boostbook.dtd.code">code</link>| ulink| <link linkend="boostbook.dtd.functionname">functionname</link>| methodname| classname)*
1549</refsynopsisdiv>
1550    <refsection>
1551      <title>Attributes</title>
1552      <informaltable>
1553        <tgroup cols="4">
1554          <thead>
1555            <row>
1556              <entry>Name</entry>
1557              <entry>Type</entry>
1558              <entry>Value</entry>
1559              <entry>Purpose</entry>
1560            </row>
1561          </thead>
1562          <tbody>
1563
1564<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1565<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1566<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1567</tbody>
1568        </tgroup>
1569      </informaltable>
1570    </refsection>
1571  </refentry>
1572  <refentry id="boostbook.dtd.copy-assignment">
1573    <refmeta>
1574      <refentrytitle>
1575          BoostBook element <sgmltag>copy-assignment</sgmltag></refentrytitle>
1576      <manvolnum>9</manvolnum>
1577    </refmeta>
1578    <refnamediv>
1579      <refname>copy-assignment</refname>
1580      <refpurpose>Declares a copy-assignment operator</refpurpose>
1581    </refnamediv>
1582    <refsynopsisdiv>copy-assignment ::=
1583  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.type">type</link>?, <link linkend="boostbook.dtd.parameter">parameter</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
1584</refsynopsisdiv>
1585    <refsection><title>Description</title>
1586  <para>The return type of the copy-assignment operator does not need
1587  to be specified. If left unspecified, it will default to an
1588  unqualified reference to the enclosing class type.</para>
1589
1590  <para>General documentation on functions in BoostBook is provided in
1591  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
1592  element documentation.</para>
1593</refsection>
1594    <refsection>
1595      <title>Attributes</title>
1596      <informaltable>
1597        <tgroup cols="4">
1598          <thead>
1599            <row>
1600              <entry>Name</entry>
1601              <entry>Type</entry>
1602              <entry>Value</entry>
1603              <entry>Purpose</entry>
1604            </row>
1605          </thead>
1606          <tbody>
1607
1608<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1609<row><entry>cv</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>cv-qualifiers for this method, e.g., const volatile</entry></row>
1610<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
1611<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1612<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1613</tbody>
1614        </tgroup>
1615      </informaltable>
1616    </refsection>
1617  </refentry>
1618  <refentry id="boostbook.dtd.run-fail-test">
1619    <refmeta>
1620      <refentrytitle>
1621          BoostBook element <sgmltag>run-fail-test</sgmltag></refentrytitle>
1622      <manvolnum>9</manvolnum>
1623    </refmeta>
1624    <refnamediv>
1625      <refname>run-fail-test</refname>
1626      <refpurpose>A testcase that should compile and link, but fail on execution</refpurpose>
1627    </refnamediv>
1628    <refsynopsisdiv>run-fail-test ::=
1629  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
1630</refsynopsisdiv>
1631    <refsection>
1632      <title>Attributes</title>
1633      <informaltable>
1634        <tgroup cols="4">
1635          <thead>
1636            <row>
1637              <entry>Name</entry>
1638              <entry>Type</entry>
1639              <entry>Value</entry>
1640              <entry>Purpose</entry>
1641            </row>
1642          </thead>
1643          <tbody>
1644
1645<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
1646<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1647</tbody>
1648        </tgroup>
1649      </informaltable>
1650    </refsection>
1651  </refentry>
1652  <refentry id="boostbook.dtd.template">
1653    <refmeta>
1654      <refentrytitle>
1655          BoostBook element <sgmltag>template</sgmltag></refentrytitle>
1656      <manvolnum>9</manvolnum>
1657    </refmeta>
1658    <refnamediv>
1659      <refname>template</refname>
1660      <refpurpose>Declares the template parameters of a class or function</refpurpose>
1661    </refnamediv>
1662    <refsynopsisdiv>template ::=
1663  (<link linkend="boostbook.dtd.template-type-parameter">template-type-parameter</link>| <link linkend="boostbook.dtd.template-nontype-parameter">template-nontype-parameter</link>| <link linkend="boostbook.dtd.template-varargs">template-varargs</link>)*
1664</refsynopsisdiv>
1665    <refsection>
1666      <title>Attributes</title>
1667      <informaltable>
1668        <tgroup cols="4">
1669          <thead>
1670            <row>
1671              <entry>Name</entry>
1672              <entry>Type</entry>
1673              <entry>Value</entry>
1674              <entry>Purpose</entry>
1675            </row>
1676          </thead>
1677          <tbody>
1678
1679<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1680<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1681<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1682</tbody>
1683        </tgroup>
1684      </informaltable>
1685    </refsection>
1686  </refentry>
1687  <refentry id="boostbook.dtd.compile-fail-test">
1688    <refmeta>
1689      <refentrytitle>
1690          BoostBook element <sgmltag>compile-fail-test</sgmltag></refentrytitle>
1691      <manvolnum>9</manvolnum>
1692    </refmeta>
1693    <refnamediv>
1694      <refname>compile-fail-test</refname>
1695      <refpurpose>A testcase that should fail to compile</refpurpose>
1696    </refnamediv>
1697    <refsynopsisdiv>compile-fail-test ::=
1698  (<link linkend="boostbook.dtd.source">source</link>*, <link linkend="boostbook.dtd.lib">lib</link>*, <link linkend="boostbook.dtd.requirement">requirement</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>, <link linkend="boostbook.dtd.if-fails">if-fails</link>?)
1699</refsynopsisdiv>
1700    <refsection>
1701      <title>Attributes</title>
1702      <informaltable>
1703        <tgroup cols="4">
1704          <thead>
1705            <row>
1706              <entry>Name</entry>
1707              <entry>Type</entry>
1708              <entry>Value</entry>
1709              <entry>Purpose</entry>
1710            </row>
1711          </thead>
1712          <tbody>
1713
1714<row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row>
1715<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1716</tbody>
1717        </tgroup>
1718      </informaltable>
1719    </refsection>
1720  </refentry>
1721  <refentry id="boostbook.dtd.returns">
1722    <refmeta>
1723      <refentrytitle>
1724          BoostBook element <sgmltag>returns</sgmltag></refentrytitle>
1725      <manvolnum>9</manvolnum>
1726    </refmeta>
1727    <refnamediv>
1728      <refname>returns</refname>
1729      <refpurpose>Description of the return value of a function</refpurpose>
1730    </refnamediv>
1731    <refsynopsisdiv>returns ::=
1732  (ANY)
1733</refsynopsisdiv>
1734    <refsection>
1735      <title>Attributes</title>
1736      <informaltable>
1737        <tgroup cols="4">
1738          <thead>
1739            <row>
1740              <entry>Name</entry>
1741              <entry>Type</entry>
1742              <entry>Value</entry>
1743              <entry>Purpose</entry>
1744            </row>
1745          </thead>
1746          <tbody>
1747
1748<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1749<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1750<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1751</tbody>
1752        </tgroup>
1753      </informaltable>
1754    </refsection>
1755  </refentry>
1756  <refentry id="boostbook.dtd.default">
1757    <refmeta>
1758      <refentrytitle>
1759          BoostBook element <sgmltag>default</sgmltag></refentrytitle>
1760      <manvolnum>9</manvolnum>
1761    </refmeta>
1762    <refnamediv>
1763      <refname>default</refname>
1764      <refpurpose>The default value of a function or template parameter</refpurpose>
1765    </refnamediv>
1766    <refsynopsisdiv>default ::=
1767  (ANY)
1768</refsynopsisdiv>
1769    <refsection>
1770      <title>Attributes</title>
1771      <informaltable>
1772        <tgroup cols="4">
1773          <thead>
1774            <row>
1775              <entry>Name</entry>
1776              <entry>Type</entry>
1777              <entry>Value</entry>
1778              <entry>Purpose</entry>
1779            </row>
1780          </thead>
1781          <tbody>
1782
1783<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1784<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1785<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1786</tbody>
1787        </tgroup>
1788      </informaltable>
1789    </refsection>
1790  </refentry>
1791  <refentry id="boostbook.dtd.parameter">
1792    <refmeta>
1793      <refentrytitle>
1794          BoostBook element <sgmltag>parameter</sgmltag></refentrytitle>
1795      <manvolnum>9</manvolnum>
1796    </refmeta>
1797    <refnamediv>
1798      <refname>parameter</refname>
1799      <refpurpose>A function parameter</refpurpose>
1800    </refnamediv>
1801    <refsynopsisdiv>parameter ::=
1802  (<link linkend="boostbook.dtd.paramtype">paramtype</link>, <link linkend="boostbook.dtd.default">default</link>?)
1803</refsynopsisdiv>
1804    <refsection>
1805      <title>Attributes</title>
1806      <informaltable>
1807        <tgroup cols="4">
1808          <thead>
1809            <row>
1810              <entry>Name</entry>
1811              <entry>Type</entry>
1812              <entry>Value</entry>
1813              <entry>Purpose</entry>
1814            </row>
1815          </thead>
1816          <tbody>
1817
1818<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1819</tbody>
1820        </tgroup>
1821      </informaltable>
1822    </refsection>
1823  </refentry>
1824  <refentry id="boostbook.dtd.signature">
1825    <refmeta>
1826      <refentrytitle>
1827          BoostBook element <sgmltag>signature</sgmltag></refentrytitle>
1828      <manvolnum>9</manvolnum>
1829    </refmeta>
1830    <refnamediv>
1831      <refname>signature</refname>
1832      <refpurpose>One signature of an overloaded function or method</refpurpose>
1833    </refnamediv>
1834    <refsynopsisdiv>signature ::=
1835  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.parameter">parameter</link>*)
1836</refsynopsisdiv>
1837    <refsection><title>Description</title>
1838  <para>
1839    A signature refers to one declaration of an overloaded function or
1840    method. The signature itself has no name, because the name of the
1841    overloaded function or method is used. An overloaded function or
1842    method will have several signatures that will generally be typeset
1843    together.
1844  </para>
1845</refsection>
1846    <refsection>
1847      <title>Attributes</title>
1848      <informaltable>
1849        <tgroup cols="4">
1850          <thead>
1851            <row>
1852              <entry>Name</entry>
1853              <entry>Type</entry>
1854              <entry>Value</entry>
1855              <entry>Purpose</entry>
1856            </row>
1857          </thead>
1858          <tbody>
1859
1860<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1861<row><entry>cv</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>cv-qualifiers for this method, e.g., const volatile</entry></row>
1862<row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row>
1863<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1864<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1865</tbody>
1866        </tgroup>
1867      </informaltable>
1868    </refsection>
1869  </refentry>
1870  <refentry id="boostbook.dtd.overloaded-function">
1871    <refmeta>
1872      <refentrytitle>
1873          BoostBook element <sgmltag>overloaded-function</sgmltag></refentrytitle>
1874      <manvolnum>9</manvolnum>
1875    </refmeta>
1876    <refnamediv>
1877      <refname>overloaded-function</refname>
1878      <refpurpose>An overloaded function</refpurpose>
1879    </refnamediv>
1880    <refsynopsisdiv>overloaded-function ::=
1881  (<link linkend="boostbook.dtd.signature">signature</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
1882</refsynopsisdiv>
1883    <refsection><title>Description</title>
1884  <para>General documentation on functions in BoostBook is provided in
1885  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
1886  element documentation.</para>
1887</refsection>
1888    <refsection>
1889      <title>Attributes</title>
1890      <informaltable>
1891        <tgroup cols="4">
1892          <thead>
1893            <row>
1894              <entry>Name</entry>
1895              <entry>Type</entry>
1896              <entry>Value</entry>
1897              <entry>Purpose</entry>
1898            </row>
1899          </thead>
1900          <tbody>
1901
1902<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1903<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1904<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1905<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1906</tbody>
1907        </tgroup>
1908      </informaltable>
1909    </refsection>
1910  </refentry>
1911  <refentry id="boostbook.dtd.class">
1912    <refmeta>
1913      <refentrytitle>
1914          BoostBook element <sgmltag>class</sgmltag></refentrytitle>
1915      <manvolnum>9</manvolnum>
1916    </refmeta>
1917    <refnamediv>
1918      <refname>class</refname>
1919      <refpurpose>Declares a class or class template</refpurpose>
1920    </refnamediv>
1921    <refsynopsisdiv>class ::=
1922  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
1923</refsynopsisdiv>
1924    <refsection><title>Description</title>
1925  <para>C++ classes and class templates are described via the
1926  &lt;class&gt; element. Each class has a name (e.g., &quot;any&quot;) given by
1927  the <code>name</code> attribute, a purpose given by the
1928  &lt;purpose&gt; element, documentation, and a set of types,
1929  functions, base classes, and data members. Here is a minimal
1930  definition of the <classname>boost::any</classname> class:</para>
1931
1932  <programlisting>&lt;namespace name=&quot;boost&quot;&gt;
1933  &lt;class name=&quot;any&quot;&gt;
1934    &lt;purpose&gt;
1935      A class whose instances can hold instances of any type that satisfies
1936      ValueType requirements.
1937    &lt;/purpose&gt;
1938  &lt;/class&gt;
1939&lt;/namespace&gt;</programlisting>
1940
1941  <para>Additional class documentation can be contained in a
1942  <sgmltag>description</sgmltag> element following the &lt;purpose&gt;
1943  element. This documentation will be typeset prior to documentation
1944  for specific elements in the class (e.g., constructors or
1945  methods).</para>
1946
1947  <para>Class inheritance is described via the &lt;inherit&gt;
1948  element. The &lt;inherit&gt; element requires an <code>access</code>
1949  attribute which must be one of <emphasis>public</emphasis>,
1950  <emphasis>protected</emphasis>, or <emphasis>private</emphasis>. The
1951  content of the &lt;inherited&gt; element in C++ code that names the
1952  class inherited, and may contain markup to link to the class. The
1953  following description of the class
1954  <classname>boost::bad_any_cast</classname> describes public
1955  inheritance from the class <classname>std::bad_cast</classname>. It
1956  also defines the &lt;purpose&gt; element, which contains a short
1957  description of the use of the class.</para>
1958   
1959  <programlisting>&lt;class name=&quot;bad_any_cast&quot;&gt;
1960  &lt;inherit access=&quot;public&quot;&gt;&lt;classname&gt;std::bad_cast&lt;/classname&gt;&lt;/inherit&gt;
1961  &lt;purpose&gt;&lt;para&gt;The exception thrown in the event of a failed
1962  &lt;functionname&gt;any_cast&lt;/functionname&gt; of an
1963  &lt;classname&gt;any&lt;/classname&gt; value.&lt;/para&gt;&lt;/purpose&gt;
1964&lt;/class&gt;</programlisting>
1965
1966  <para>Class templates are defined by &lt;class&gt; elements with a
1967  &lt;template&gt; child element at the beginning.</para>
1968</refsection>
1969    <refsection>
1970      <title>Attributes</title>
1971      <informaltable>
1972        <tgroup cols="4">
1973          <thead>
1974            <row>
1975              <entry>Name</entry>
1976              <entry>Type</entry>
1977              <entry>Value</entry>
1978              <entry>Purpose</entry>
1979            </row>
1980          </thead>
1981          <tbody>
1982
1983<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
1984<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
1985<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
1986<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
1987</tbody>
1988        </tgroup>
1989      </informaltable>
1990    </refsection>
1991  </refentry>
1992  <refentry id="boostbook.dtd.librarycategorydef">
1993    <refmeta>
1994      <refentrytitle>
1995          BoostBook element <sgmltag>librarycategorydef</sgmltag></refentrytitle>
1996      <manvolnum>9</manvolnum>
1997    </refmeta>
1998    <refnamediv>
1999      <refname>librarycategorydef</refname>
2000      <refpurpose>Defines a new library category</refpurpose>
2001    </refnamediv>
2002    <refsynopsisdiv>librarycategorydef ::=
2003  (#PCDATA)
2004</refsynopsisdiv>
2005    <refsection><title>Description</title>
2006  <para>All library category definitions should be in <filename>doc/src/boost.xml</filename>, and the names of categories must be prefixed with &quot;<code>category:</code>&quot;.</para>
2007</refsection>
2008    <refsection>
2009      <title>Attributes</title>
2010      <informaltable>
2011        <tgroup cols="4">
2012          <thead>
2013            <row>
2014              <entry>Name</entry>
2015              <entry>Type</entry>
2016              <entry>Value</entry>
2017              <entry>Purpose</entry>
2018            </row>
2019          </thead>
2020          <tbody>
2021
2022<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2023<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2024<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2025<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2026</tbody>
2027        </tgroup>
2028      </informaltable>
2029    </refsection>
2030  </refentry>
2031  <refentry id="boostbook.dtd.type">
2032    <refmeta>
2033      <refentrytitle>
2034          BoostBook element <sgmltag>type</sgmltag></refentrytitle>
2035      <manvolnum>9</manvolnum>
2036    </refmeta>
2037    <refnamediv>
2038      <refname>type</refname>
2039      <refpurpose>The type of an element or return type of a function</refpurpose>
2040    </refnamediv>
2041    <refsynopsisdiv>type ::=
2042  (ANY)
2043</refsynopsisdiv>
2044    <refsection>
2045      <title>Attributes</title>
2046      <informaltable>
2047        <tgroup cols="4">
2048          <thead>
2049            <row>
2050              <entry>Name</entry>
2051              <entry>Type</entry>
2052              <entry>Value</entry>
2053              <entry>Purpose</entry>
2054            </row>
2055          </thead>
2056          <tbody>
2057
2058<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2059<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2060<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2061</tbody>
2062        </tgroup>
2063      </informaltable>
2064    </refsection>
2065  </refentry>
2066  <refentry id="boostbook.dtd.enumvalue">
2067    <refmeta>
2068      <refentrytitle>
2069          BoostBook element <sgmltag>enumvalue</sgmltag></refentrytitle>
2070      <manvolnum>9</manvolnum>
2071    </refmeta>
2072    <refnamediv>
2073      <refname>enumvalue</refname>
2074      <refpurpose>A single value of an enumeration</refpurpose>
2075    </refnamediv>
2076    <refsynopsisdiv>enumvalue ::=
2077  (<link linkend="boostbook.dtd.default">default</link>?)
2078</refsynopsisdiv>
2079    <refsection>
2080      <title>Attributes</title>
2081      <informaltable>
2082        <tgroup cols="4">
2083          <thead>
2084            <row>
2085              <entry>Name</entry>
2086              <entry>Type</entry>
2087              <entry>Value</entry>
2088              <entry>Purpose</entry>
2089            </row>
2090          </thead>
2091          <tbody>
2092
2093<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2094<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2095<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2096<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2097</tbody>
2098        </tgroup>
2099      </informaltable>
2100    </refsection>
2101  </refentry>
2102  <refentry id="boostbook.dtd.overloaded-method">
2103    <refmeta>
2104      <refentrytitle>
2105          BoostBook element <sgmltag>overloaded-method</sgmltag></refentrytitle>
2106      <manvolnum>9</manvolnum>
2107    </refmeta>
2108    <refnamediv>
2109      <refname>overloaded-method</refname>
2110      <refpurpose>An overloaded method</refpurpose>
2111    </refnamediv>
2112    <refsynopsisdiv>overloaded-method ::=
2113  (<link linkend="boostbook.dtd.signature">signature</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, <link linkend="boostbook.dtd.requires">requires</link>?, <link linkend="boostbook.dtd.effects">effects</link>?, <link linkend="boostbook.dtd.postconditions">postconditions</link>?, <link linkend="boostbook.dtd.returns">returns</link>?, <link linkend="boostbook.dtd.throws">throws</link>?, <link linkend="boostbook.dtd.complexity">complexity</link>?, <link linkend="boostbook.dtd.notes">notes</link>?, <link linkend="boostbook.dtd.rationale">rationale</link>?)
2114</refsynopsisdiv>
2115    <refsection><title>Description</title>
2116  <para>General documentation on functions in BoostBook is provided in
2117  the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
2118  element documentation.</para>
2119</refsection>
2120    <refsection>
2121      <title>Attributes</title>
2122      <informaltable>
2123        <tgroup cols="4">
2124          <thead>
2125            <row>
2126              <entry>Name</entry>
2127              <entry>Type</entry>
2128              <entry>Value</entry>
2129              <entry>Purpose</entry>
2130            </row>
2131          </thead>
2132          <tbody>
2133
2134<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2135<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2136<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2137<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2138</tbody>
2139        </tgroup>
2140      </informaltable>
2141    </refsection>
2142  </refentry>
2143  <refentry id="boostbook.dtd.programlisting">
2144    <refmeta>
2145      <refentrytitle>
2146          BoostBook element <sgmltag>programlisting</sgmltag></refentrytitle>
2147      <manvolnum>9</manvolnum>
2148    </refmeta>
2149    <refnamediv>
2150      <refname>programlisting</refname>
2151      <refpurpose>A sample of program code</refpurpose>
2152    </refnamediv>
2153    <refsynopsisdiv>programlisting ::=
2154  (ANY)
2155</refsynopsisdiv>
2156    <refsection>
2157      <title>Attributes</title>
2158      <informaltable>
2159        <tgroup cols="4">
2160          <thead>
2161            <row>
2162              <entry>Name</entry>
2163              <entry>Type</entry>
2164              <entry>Value</entry>
2165              <entry>Purpose</entry>
2166            </row>
2167          </thead>
2168          <tbody>
2169
2170<row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2171</tbody>
2172        </tgroup>
2173      </informaltable>
2174    </refsection>
2175  </refentry>
2176  <refentry id="boostbook.dtd.complexity">
2177    <refmeta>
2178      <refentrytitle>
2179          BoostBook element <sgmltag>complexity</sgmltag></refentrytitle>
2180      <manvolnum>9</manvolnum>
2181    </refmeta>
2182    <refnamediv>
2183      <refname>complexity</refname>
2184      <refpurpose>The time/space/etc. complexity of a function</refpurpose>
2185    </refnamediv>
2186    <refsynopsisdiv>complexity ::=
2187  (ANY)
2188</refsynopsisdiv>
2189    <refsection>
2190      <title>Attributes</title>
2191      <informaltable>
2192        <tgroup cols="4">
2193          <thead>
2194            <row>
2195              <entry>Name</entry>
2196              <entry>Type</entry>
2197              <entry>Value</entry>
2198              <entry>Purpose</entry>
2199            </row>
2200          </thead>
2201          <tbody>
2202
2203<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2204<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2205<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2206</tbody>
2207        </tgroup>
2208      </informaltable>
2209    </refsection>
2210  </refentry>
2211  <refentry id="boostbook.dtd.purpose">
2212    <refmeta>
2213      <refentrytitle>
2214          BoostBook element <sgmltag>purpose</sgmltag></refentrytitle>
2215      <manvolnum>9</manvolnum>
2216    </refmeta>
2217    <refnamediv>
2218      <refname>purpose</refname>
2219      <refpurpose>A short description of an entity's use</refpurpose>
2220    </refnamediv>
2221    <refsynopsisdiv>purpose ::=
2222  (ANY)
2223</refsynopsisdiv>
2224    <refsection>
2225      <title>Attributes</title>
2226      <informaltable>
2227        <tgroup cols="4">
2228          <thead>
2229            <row>
2230              <entry>Name</entry>
2231              <entry>Type</entry>
2232              <entry>Value</entry>
2233              <entry>Purpose</entry>
2234            </row>
2235          </thead>
2236          <tbody>
2237
2238<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2239<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2240<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2241</tbody>
2242        </tgroup>
2243      </informaltable>
2244    </refsection>
2245  </refentry>
2246  <refentry id="boostbook.dtd.template-nontype-parameter">
2247    <refmeta>
2248      <refentrytitle>
2249          BoostBook element <sgmltag>template-nontype-parameter</sgmltag></refentrytitle>
2250      <manvolnum>9</manvolnum>
2251    </refmeta>
2252    <refnamediv>
2253      <refname>template-nontype-parameter</refname>
2254      <refpurpose>A nontype template parameter</refpurpose>
2255    </refnamediv>
2256    <refsynopsisdiv>template-nontype-parameter ::=
2257  (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.default">default</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?)
2258</refsynopsisdiv>
2259    <refsection>
2260      <title>Attributes</title>
2261      <informaltable>
2262        <tgroup cols="4">
2263          <thead>
2264            <row>
2265              <entry>Name</entry>
2266              <entry>Type</entry>
2267              <entry>Value</entry>
2268              <entry>Purpose</entry>
2269            </row>
2270          </thead>
2271          <tbody>
2272
2273<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2274<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2275<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2276<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2277</tbody>
2278        </tgroup>
2279      </informaltable>
2280    </refsection>
2281  </refentry>
2282  <refentry id="boostbook.dtd.library">
2283    <refmeta>
2284      <refentrytitle>
2285          BoostBook element <sgmltag>library</sgmltag></refentrytitle>
2286      <manvolnum>9</manvolnum>
2287    </refmeta>
2288    <refnamediv>
2289      <refname>library</refname>
2290      <refpurpose>Top-level element for a library</refpurpose>
2291    </refnamediv>
2292    <refsynopsisdiv>library ::=
2293  (<link linkend="boostbook.dtd.libraryinfo">libraryinfo</link>, (title, ((section| <link linkend="boostbook.dtd.library-reference">library-reference</link>| <link linkend="boostbook.dtd.testsuite">testsuite</link>))+)?)
2294</refsynopsisdiv>
2295    <refsection>
2296      <title>Attributes</title>
2297      <informaltable>
2298        <tgroup cols="4">
2299          <thead>
2300            <row>
2301              <entry>Name</entry>
2302              <entry>Type</entry>
2303              <entry>Value</entry>
2304              <entry>Purpose</entry>
2305            </row>
2306          </thead>
2307          <tbody>
2308
2309<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2310<row><entry>dirname</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry/></row>
2311<row><entry>url</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row>
2312<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2313<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2314<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2315<row><entry>html-only</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row>
2316</tbody>
2317        </tgroup>
2318      </informaltable>
2319    </refsection>
2320  </refentry>
2321  <refentry id="boostbook.dtd.librarycategorylist">
2322    <refmeta>
2323      <refentrytitle>
2324          BoostBook element <sgmltag>librarycategorylist</sgmltag></refentrytitle>
2325      <manvolnum>9</manvolnum>
2326    </refmeta>
2327    <refnamediv>
2328      <refname>librarycategorylist</refname>
2329      <refpurpose>Categorized listing of libraries</refpurpose>
2330    </refnamediv>
2331    <refsynopsisdiv>librarycategorylist ::=
2332  (<link linkend="boostbook.dtd.librarycategorydef">librarycategorydef</link>)*
2333</refsynopsisdiv>
2334    <refsection><title>Description</title>
2335  <para>This element is not intended for use by developers, but is
2336  used by <filename>doc/src/boost.xml</filename> as a
2337  placeholder.</para>
2338</refsection>
2339    <refsection>
2340      <title>Attributes</title>
2341      <informaltable>
2342        <tgroup cols="4">
2343          <thead>
2344            <row>
2345              <entry>Name</entry>
2346              <entry>Type</entry>
2347              <entry>Value</entry>
2348              <entry>Purpose</entry>
2349            </row>
2350          </thead>
2351          <tbody>
2352
2353<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2354<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2355<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2356</tbody>
2357        </tgroup>
2358      </informaltable>
2359    </refsection>
2360  </refentry>
2361  <refentry id="boostbook.dtd.using-namespace">
2362    <refmeta>
2363      <refentrytitle>
2364          BoostBook element <sgmltag>using-namespace</sgmltag></refentrytitle>
2365      <manvolnum>9</manvolnum>
2366    </refmeta>
2367    <refnamediv>
2368      <refname>using-namespace</refname>
2369      <refpurpose>Injects the declared names from a namespace into the local scope</refpurpose>
2370    </refnamediv>
2371    <refsynopsisdiv>using-namespace ::=
2372  EMPTY
2373</refsynopsisdiv>
2374    <refsection>
2375      <title>Attributes</title>
2376      <informaltable>
2377        <tgroup cols="4">
2378          <thead>
2379            <row>
2380              <entry>Name</entry>
2381              <entry>Type</entry>
2382              <entry>Value</entry>
2383              <entry>Purpose</entry>
2384            </row>
2385          </thead>
2386          <tbody>
2387
2388<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2389<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2390<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2391<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2392</tbody>
2393        </tgroup>
2394      </informaltable>
2395    </refsection>
2396  </refentry>
2397  <refentry id="boostbook.dtd.struct-specialization">
2398    <refmeta>
2399      <refentrytitle>
2400          BoostBook element <sgmltag>struct-specialization</sgmltag></refentrytitle>
2401      <manvolnum>9</manvolnum>
2402    </refmeta>
2403    <refnamediv>
2404      <refname>struct-specialization</refname>
2405      <refpurpose>A specialization (full or partial) of a struct template</refpurpose>
2406    </refnamediv>
2407    <refsynopsisdiv>struct-specialization ::=
2408  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.specialization">specialization</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
2409</refsynopsisdiv>
2410    <refsection>
2411      <title>Attributes</title>
2412      <informaltable>
2413        <tgroup cols="4">
2414          <thead>
2415            <row>
2416              <entry>Name</entry>
2417              <entry>Type</entry>
2418              <entry>Value</entry>
2419              <entry>Purpose</entry>
2420            </row>
2421          </thead>
2422          <tbody>
2423
2424<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2425<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2426<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2427<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2428</tbody>
2429        </tgroup>
2430      </informaltable>
2431    </refsection>
2432  </refentry>
2433  <refentry id="boostbook.dtd.struct">
2434    <refmeta>
2435      <refentrytitle>
2436          BoostBook element <sgmltag>struct</sgmltag></refentrytitle>
2437      <manvolnum>9</manvolnum>
2438    </refmeta>
2439    <refnamediv>
2440      <refname>struct</refname>
2441      <refpurpose>Declares a C++ struct</refpurpose>
2442    </refnamediv>
2443    <refsynopsisdiv>struct ::=
2444  (<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.inherit">inherit</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?, (<link linkend="boostbook.dtd.static-constant">static-constant</link>| <link linkend="boostbook.dtd.typedef">typedef</link>| <link linkend="boostbook.dtd.enum">enum</link>| <link linkend="boostbook.dtd.copy-assignment">copy-assignment</link>| <link linkend="boostbook.dtd.constructor">constructor</link>| <link linkend="boostbook.dtd.destructor">destructor</link>| <link linkend="boostbook.dtd.method-group">method-group</link>| <link linkend="boostbook.dtd.free-function-group">free-function-group</link>| <link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>| <link linkend="boostbook.dtd.data-member">data-member</link>| <link linkend="boostbook.dtd.class">class</link>| <link linkend="boostbook.dtd.class-specialization">class-specialization</link>| <link linkend="boostbook.dtd.struct">struct</link>| <link linkend="boostbook.dtd.struct-specialization">struct-specialization</link>| <link linkend="boostbook.dtd.union">union</link>| <link linkend="boostbook.dtd.union-specialization">union-specialization</link>)*)
2445</refsynopsisdiv>
2446    <refsection>
2447      <title>Attributes</title>
2448      <informaltable>
2449        <tgroup cols="4">
2450          <thead>
2451            <row>
2452              <entry>Name</entry>
2453              <entry>Type</entry>
2454              <entry>Value</entry>
2455              <entry>Purpose</entry>
2456            </row>
2457          </thead>
2458          <tbody>
2459
2460<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2461<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2462<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2463<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2464</tbody>
2465        </tgroup>
2466      </informaltable>
2467    </refsection>
2468  </refentry>
2469  <refentry id="boostbook.dtd.lib">
2470    <refmeta>
2471      <refentrytitle>
2472          BoostBook element <sgmltag>lib</sgmltag></refentrytitle>
2473      <manvolnum>9</manvolnum>
2474    </refmeta>
2475    <refnamediv>
2476      <refname>lib</refname>
2477      <refpurpose>A library dependency</refpurpose>
2478    </refnamediv>
2479    <refsynopsisdiv>lib ::=
2480  (#PCDATA)
2481</refsynopsisdiv>
2482    <refsection><title>Description</title>
2483  <para>Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile.</para>
2484</refsection>
2485  </refentry>
2486  <refentry id="boostbook.dtd.enum">
2487    <refmeta>
2488      <refentrytitle>
2489          BoostBook element <sgmltag>enum</sgmltag></refentrytitle>
2490      <manvolnum>9</manvolnum>
2491    </refmeta>
2492    <refnamediv>
2493      <refname>enum</refname>
2494      <refpurpose>Declares an enumeration type</refpurpose>
2495    </refnamediv>
2496    <refsynopsisdiv>enum ::=
2497  (<link linkend="boostbook.dtd.enumvalue">enumvalue</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
2498</refsynopsisdiv>
2499    <refsection>
2500      <title>Attributes</title>
2501      <informaltable>
2502        <tgroup cols="4">
2503          <thead>
2504            <row>
2505              <entry>Name</entry>
2506              <entry>Type</entry>
2507              <entry>Value</entry>
2508              <entry>Purpose</entry>
2509            </row>
2510          </thead>
2511          <tbody>
2512
2513<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2514<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2515<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2516<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2517</tbody>
2518        </tgroup>
2519      </informaltable>
2520    </refsection>
2521  </refentry>
2522  <refentry id="boostbook.dtd.requires">
2523    <refmeta>
2524      <refentrytitle>
2525          BoostBook element <sgmltag>requires</sgmltag></refentrytitle>
2526      <manvolnum>9</manvolnum>
2527    </refmeta>
2528    <refnamediv>
2529      <refname>requires</refname>
2530      <refpurpose>Declares the requirements of a function</refpurpose>
2531    </refnamediv>
2532    <refsynopsisdiv>requires ::=
2533  (ANY)
2534</refsynopsisdiv>
2535    <refsection>
2536      <title>Attributes</title>
2537      <informaltable>
2538        <tgroup cols="4">
2539          <thead>
2540            <row>
2541              <entry>Name</entry>
2542              <entry>Type</entry>
2543              <entry>Value</entry>
2544              <entry>Purpose</entry>
2545            </row>
2546          </thead>
2547          <tbody>
2548
2549<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2550<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2551<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2552</tbody>
2553        </tgroup>
2554      </informaltable>
2555    </refsection>
2556  </refentry>
2557  <refentry id="boostbook.dtd.effects">
2558    <refmeta>
2559      <refentrytitle>
2560          BoostBook element <sgmltag>effects</sgmltag></refentrytitle>
2561      <manvolnum>9</manvolnum>
2562    </refmeta>
2563    <refnamediv>
2564      <refname>effects</refname>
2565      <refpurpose>Declares the side effects of a function</refpurpose>
2566    </refnamediv>
2567    <refsynopsisdiv>effects ::=
2568  (ANY)
2569</refsynopsisdiv>
2570    <refsection>
2571      <title>Attributes</title>
2572      <informaltable>
2573        <tgroup cols="4">
2574          <thead>
2575            <row>
2576              <entry>Name</entry>
2577              <entry>Type</entry>
2578              <entry>Value</entry>
2579              <entry>Purpose</entry>
2580            </row>
2581          </thead>
2582          <tbody>
2583
2584<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2585<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2586<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2587</tbody>
2588        </tgroup>
2589      </informaltable>
2590    </refsection>
2591  </refentry>
2592  <refentry id="boostbook.dtd.libraryname">
2593    <refmeta>
2594      <refentrytitle>
2595          BoostBook element <sgmltag>libraryname</sgmltag></refentrytitle>
2596      <manvolnum>9</manvolnum>
2597    </refmeta>
2598    <refnamediv>
2599      <refname>libraryname</refname>
2600      <refpurpose>References a library of the given name</refpurpose>
2601    </refnamediv>
2602    <refsynopsisdiv>libraryname ::=
2603  (#PCDATA)
2604</refsynopsisdiv>
2605    <refsection>
2606      <title>Attributes</title>
2607      <informaltable>
2608        <tgroup cols="4">
2609          <thead>
2610            <row>
2611              <entry>Name</entry>
2612              <entry>Type</entry>
2613              <entry>Value</entry>
2614              <entry>Purpose</entry>
2615            </row>
2616          </thead>
2617          <tbody>
2618
2619<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2620<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2621<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2622</tbody>
2623        </tgroup>
2624      </informaltable>
2625    </refsection>
2626  </refentry>
2627  <refentry id="boostbook.dtd.libraryinfo">
2628    <refmeta>
2629      <refentrytitle>
2630          BoostBook element <sgmltag>libraryinfo</sgmltag></refentrytitle>
2631      <manvolnum>9</manvolnum>
2632    </refmeta>
2633    <refnamediv>
2634      <refname>libraryinfo</refname>
2635      <refpurpose>Provides information about a library</refpurpose>
2636    </refnamediv>
2637    <refsynopsisdiv>libraryinfo ::=
2638  (author+, copyright*, legalnotice*, <link linkend="boostbook.dtd.librarypurpose">librarypurpose</link>, <link linkend="boostbook.dtd.librarycategory">librarycategory</link>*)
2639</refsynopsisdiv>
2640    <refsection>
2641      <title>Attributes</title>
2642      <informaltable>
2643        <tgroup cols="4">
2644          <thead>
2645            <row>
2646              <entry>Name</entry>
2647              <entry>Type</entry>
2648              <entry>Value</entry>
2649              <entry>Purpose</entry>
2650            </row>
2651          </thead>
2652          <tbody>
2653
2654<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2655<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2656<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2657</tbody>
2658        </tgroup>
2659      </informaltable>
2660    </refsection>
2661  </refentry>
2662  <refentry id="boostbook.dtd.testsuite">
2663    <refmeta>
2664      <refentrytitle>
2665          BoostBook element <sgmltag>testsuite</sgmltag></refentrytitle>
2666      <manvolnum>9</manvolnum>
2667    </refmeta>
2668    <refnamediv>
2669      <refname>testsuite</refname>
2670      <refpurpose>Describes a library testsuite</refpurpose>
2671    </refnamediv>
2672    <refsynopsisdiv>testsuite ::=
2673  ((<link linkend="boostbook.dtd.compile-test">compile-test</link>| <link linkend="boostbook.dtd.link-test">link-test</link>| <link linkend="boostbook.dtd.run-test">run-test</link>| <link linkend="boostbook.dtd.compile-fail-test">compile-fail-test</link>| <link linkend="boostbook.dtd.link-fail-test">link-fail-test</link>| <link linkend="boostbook.dtd.run-fail-test">run-fail-test</link>)+)
2674</refsynopsisdiv>
2675    <refsection>
2676      <title>Attributes</title>
2677      <informaltable>
2678        <tgroup cols="4">
2679          <thead>
2680            <row>
2681              <entry>Name</entry>
2682              <entry>Type</entry>
2683              <entry>Value</entry>
2684              <entry>Purpose</entry>
2685            </row>
2686          </thead>
2687          <tbody>
2688
2689<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2690<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2691<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2692</tbody>
2693        </tgroup>
2694      </informaltable>
2695    </refsection>
2696  </refentry>
2697  <refentry id="boostbook.dtd.header">
2698    <refmeta>
2699      <refentrytitle>
2700          BoostBook element <sgmltag>header</sgmltag></refentrytitle>
2701      <manvolnum>9</manvolnum>
2702    </refmeta>
2703    <refnamediv>
2704      <refname>header</refname>
2705      <refpurpose>Declares a C++ header with the given name</refpurpose>
2706    </refnamediv>
2707    <refsynopsisdiv>header ::=
2708  (ANY)
2709</refsynopsisdiv>
2710    <refsection>
2711      <title>Attributes</title>
2712      <informaltable>
2713        <tgroup cols="4">
2714          <thead>
2715            <row>
2716              <entry>Name</entry>
2717              <entry>Type</entry>
2718              <entry>Value</entry>
2719              <entry>Purpose</entry>
2720            </row>
2721          </thead>
2722          <tbody>
2723
2724<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2725<row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row>
2726<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2727<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2728</tbody>
2729        </tgroup>
2730      </informaltable>
2731    </refsection>
2732  </refentry>
2733  <refentry id="boostbook.dtd.rationale">
2734    <refmeta>
2735      <refentrytitle>
2736          BoostBook element <sgmltag>rationale</sgmltag></refentrytitle>
2737      <manvolnum>9</manvolnum>
2738    </refmeta>
2739    <refnamediv>
2740      <refname>rationale</refname>
2741      <refpurpose>Describes the rationale for a particular function's design</refpurpose>
2742    </refnamediv>
2743    <refsynopsisdiv>rationale ::=
2744  (ANY)
2745</refsynopsisdiv>
2746    <refsection>
2747      <title>Attributes</title>
2748      <informaltable>
2749        <tgroup cols="4">
2750          <thead>
2751            <row>
2752              <entry>Name</entry>
2753              <entry>Type</entry>
2754              <entry>Value</entry>
2755              <entry>Purpose</entry>
2756            </row>
2757          </thead>
2758          <tbody>
2759
2760<row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date: 2006/11/03 19:39:44 $ to keep &quot;last revised&quot; information in sync with CVS changes</entry></row>
2761<row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row>
2762<row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row>
2763</tbody>
2764        </tgroup>
2765      </informaltable>
2766    </refsection>
2767  </refentry>
2768</chapter>
Note: See TracBrowser for help on using the repository browser.