Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/tools/boostbook/doc/reference.xml @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

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