boost-react-native-bundle

<?xml version="1.0" standalone="yes"?>  <chapter id="reference"> <title>Reference</title> <para>Elements:<itemizedlist spacing="compact"><listitem><simpara><link linkend="boostbook.dtd.access">Element <sgmltag>access</sgmltag> - Declares an access specification for class members</link></simpara></listitem><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.enumname">Element <sgmltag>enumname</sgmltag> - References an enumeration type with the given name</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.globalname">Element <sgmltag>globalname</sgmltag> - References a global 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.headername">Element <sgmltag>headername</sgmltag> - References 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.macroname">Element <sgmltag>macroname</sgmltag> - References a macro with the given name</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> <refentry id="boostbook.dtd.class-specialization"> <refmeta> <refentrytitle> BoostBook element <sgmltag>class-specialization</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>class-specialization</refname> <refpurpose>A specialization (partial or full) of a class template</refpurpose> </refnamediv> <refsynopsisdiv>class-specialization ::= (<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.access">access</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>)*) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.link-test"> <refmeta> <refentrytitle> BoostBook element <sgmltag>link-test</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>link-test</refname> <refpurpose>Declares a test that should compile and link</refpurpose> </refnamediv> <refsynopsisdiv>link-test ::= (<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>?) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row> <row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.link-fail-test"> <refmeta> <refentrytitle> BoostBook element <sgmltag>link-fail-test</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>link-fail-test</refname> <refpurpose>Declares a test that should compile but fail to link</refpurpose> </refnamediv> <refsynopsisdiv>link-fail-test ::= (<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>?) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>filename</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the file associated with this element</entry></row> <row><entry>name</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.typedef"> <refmeta> <refentrytitle> BoostBook element <sgmltag>typedef</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>typedef</refname> <refpurpose>Declares a typedef</refpurpose> </refnamediv> <refsynopsisdiv>typedef ::= (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.static-constant"> <refmeta> <refentrytitle> BoostBook element <sgmltag>static-constant</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>static-constant</refname> <refpurpose>Declares a static constant, e.g., <code>const int foo = 5;</code>.</refpurpose> </refnamediv> <refsynopsisdiv>static-constant ::= (<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>?) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.code"> <refmeta> <refentrytitle> BoostBook element <sgmltag>code</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>code</refname> <refpurpose>Mimics the <sgmltag>code</sgmltag> tag in HTML</refpurpose> </refnamediv> <refsynopsisdiv>code ::= (ANY) </refsynopsisdiv> <refsection><title>Description</title> <para>Text within a <sgmltag>code</sgmltag> tag is generally typeset in a different, monospaced font so that it stands out as code. The <sgmltag>code</sgmltag> tag in BoostBook is transformed directly into the <sgmltag>computeroutput</sgmltag> tag in DocBook.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.destructor"> <refmeta> <refentrytitle> BoostBook element <sgmltag>destructor</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>destructor</refname> <refpurpose>Declares a destructor for the enclosing class</refpurpose> </refnamediv> <refsynopsisdiv>destructor ::= (<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>?) </refsynopsisdiv> <refsection><title>Description</title> <para>General documentation on functions in BoostBook is provided in the <link linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link> element documentation.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.template-type-parameter"> <refmeta> <refentrytitle> BoostBook element <sgmltag>template-type-parameter</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>template-type-parameter</refname> <refpurpose>Declares a template type parameter</refpurpose> </refnamediv> <refsynopsisdiv>template-type-parameter ::= (<link linkend="boostbook.dtd.default">default</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>pack</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to '1' if the parameter is a parameter pack.</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.description"> <refmeta> <refentrytitle> BoostBook element <sgmltag>description</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>description</refname> <refpurpose>Detailed description of a construct</refpurpose> </refnamediv> <refsynopsisdiv>description ::= (ANY) </refsynopsisdiv> <refsection><title>Description</title> <para>Although the context model for this element is <code>ANY</code>, detailed descriptions should contain structured DocBook elements that occur within sections, e.g., paragraphs (<sgmltag>para</sgmltag>, <sgmltag>simpara</sgmltag>), lists (<sgmltag>orderedlist</sgmltag>, <sgmltag>itemizedlist</sgmltag>), tables (<sgmltag>informaltable</sgmltag>, <sgmltag>table</sgmltag>), etc.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.librarylist"> <refmeta> <refentrytitle> BoostBook element <sgmltag>librarylist</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>librarylist</refname> <refpurpose>Placeholder for an alphabetical list of libraries</refpurpose> </refnamediv> <refsynopsisdiv>librarylist ::= EMPTY </refsynopsisdiv> <refsection><title>Description</title> <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> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.library-reference"> <refmeta> <refentrytitle> BoostBook element <sgmltag>library-reference</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>library-reference</refname> <refpurpose>Declares the reference material for a library</refpurpose> </refnamediv> <refsynopsisdiv>library-reference ::= (title?, section*, (<link linkend="boostbook.dtd.header">header</link>| <link linkend="boostbook.dtd.library-reference">library-reference</link>)*) </refsynopsisdiv> <refsection><title>Description</title> <para>Reference documentation for a library is contained with a <library-reference> element. The <library-reference> element has no attributes, and contains as children only <header> elements.</para> <para>The <header> element defines a C++ header file. Within each C++ header file lie the definitions of C++ constructs to be documented. The <code>name</code> attribute of the <header> element gives the name of the header, as one would specify when including the header. For instance, the <library-reference> for the <libraryname>Any</libraryname> library may look like this:</para> <programlisting><library-reference> <header name="boost/any.hpp">  </header> </library-reference></programlisting> <para>If the <libraryname>Any</libraryname> library contained multiple headers, we would list them all as children of the <library-reference> element.</para> <para><sgmltag>library-reference</sgmltag> elements can be nested, so that reference material can be divided into separate sections that each contain different headers.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.boostbook"> <refmeta> <refentrytitle> BoostBook element <sgmltag>boostbook</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>boostbook</refname> <refpurpose>Defines a BoostBook book</refpurpose> </refnamediv> <refsynopsisdiv>boostbook ::= (title, (chapter| <link linkend="boostbook.dtd.library">library</link>)*) </refsynopsisdiv> <refsection><title>Description</title> <simpara>This element is the topmost level defined by <filename>boost.xml</filename> for all Boost documentation. It will not generally be used by developers.</simpara> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.union"> <refmeta> <refentrytitle> BoostBook element <sgmltag>union</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>union</refname> <refpurpose>Declares a C++ union or union template</refpurpose> </refnamediv> <refsynopsisdiv>union ::= (<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.access">access</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>)*) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.inherit"> <refmeta> <refentrytitle> BoostBook element <sgmltag>inherit</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>inherit</refname> <refpurpose>Declares a base class of the enclosing class or struct</refpurpose> </refnamediv> <refsynopsisdiv>inherit ::= (<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?) </refsynopsisdiv> <refsection><title>Description</title> <para>This element contains the type of the class inherited.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>access</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The access specifier ("public", "private", or "protected") of the inheritance.</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>pack</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to '1' if this is a pack exapansion.</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.template-varargs"> <refmeta> <refentrytitle> BoostBook element <sgmltag>template-varargs</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>template-varargs</refname> <refpurpose>Declares a variable-length list of template parameters</refpurpose> </refnamediv> <refsynopsisdiv>template-varargs ::= EMPTY </refsynopsisdiv> <refsection><title>Description</title> <para>Variable-length template parameter lists are not allowed in C++, but because they are sometimes needed in documentation they are allowed in BoostBook. This element generally expands to "..." and can be used anywhere any other template parameter can be used.</para> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.source"> <refmeta> <refentrytitle> BoostBook element <sgmltag>source</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>source</refname> <refpurpose>Defines source code for a test</refpurpose> </refnamediv> <refsynopsisdiv>source ::= (#PCDATA| <link linkend="boostbook.dtd.snippet">snippet</link>)* </refsynopsisdiv> <refsection><title>Description</title> <para>This element will contain the source code for a testcase that will be generated from the documentation. To reduce the amount of escaping in the text, it is recommended to use CDATA sections, which look like this: <programlisting><![CDATA[ <your program text here: no escaping needed!> ]]></programlisting> </para> <para>In addition to CDATA sections, code snippets can be pulled in from <sgmltag>programlisting</sgmltag> elements using the <link linkend="boostbook.dtd.snippet"><sgmltag>snippet</sgmltag></link> element.</para> </refsection> </refentry> <refentry id="boostbook.dtd.function"> <refmeta> <refentrytitle> BoostBook element <sgmltag>function</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>function</refname> <refpurpose>Declares a function</refpurpose> </refnamediv> <refsynopsisdiv>function ::= (<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>?) </refsynopsisdiv> <refsection><title>Description</title> <para>BoostBook functions are documented by specifying the function's interface (e.g., its C++ signature) and its behavior. Constructors, destructors, member functions, and free functions all use the same documentation method, although the top-level tags differ.</para> <para>The behavior of functions in BoostBook is documenting using a style similar to that of the C++ standard, with clauses describing the requirements, effects, postconditions, exception behavior, and return values of functions.</para> <para>The following example illustrates some constructors and a destructor for <classname>boost::any</classname>. Note that one of the constructors takes a single parameter whose name is "other" and whose type, <code>const any&</code> is contained in the <paramtype> element; any number of parameters may be specified in this way.</para> <programlisting><class name="any"> <constructor> <postconditions><para><this->empty()></para></postconditions> </constructor> <constructor> <parameter name="other"> <paramtype>const <classname>any</classname>&amp;</paramtype> </parameter> <effects> <simpara> Copy constructor that copies content of <code>other</code> into the new instance, so that any content is equivalent in both type and value to the content of <code>other</code>, or empty if <code>other</code> is empty. </simpara> </effects> <throws> <simpara>May fail with a <classname>std::bad_alloc</classname> exception or any exceptions arising from the copy constructor of the contained type. </simpara> </throws> </constructor> <destructor> <effects><simpara>Releases any and all resources used in management of instance.</simpara></effects> <throws><simpara>Nothing.</simpara></throws> </destructor> </class></programlisting> </refsection> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>specifiers</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>The specifiers for this function, e.g., inline, static, etc.</entry></row> <row><entry>name</entry><entry>#REQUIRED</entry><entry>CDATA</entry><entry>The name of the element being declared to referenced</entry></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> <row><entry>xml:base</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Implementation detail used by XIncludes</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.macroname"> <refmeta> <refentrytitle> BoostBook element <sgmltag>macroname</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>macroname</refname> <refpurpose/> </refnamediv> <refsynopsisdiv>macroname ::= (#PCDATA) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>Set to $Date$ to keep "last revised" information in sync with CVS changes</entry></row> <row><entry>alt</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry/></row> <row><entry>id</entry><entry>#IMPLIED</entry><entry>CDATA</entry><entry>A global identifier for this element</entry></row> </tbody> </tgroup> </informaltable> </refsection> </refentry> <refentry id="boostbook.dtd.postconditions"> <refmeta> <refentrytitle> BoostBook element <sgmltag>postconditions</sgmltag></refentrytitle> <manvolnum>9</manvolnum> </refmeta> <refnamediv> <refname>postconditions</refname> <refpurpose>Conditions that must hold after the function returns</refpurpose> </refnamediv> <refsynopsisdiv>postconditions ::= (ANY) </refsynopsisdiv> <refsection> <title>Attributes</title> <informaltable> <tgroup cols="4"> <thead> <row> <entry>Name</entry> <entry>Type</entry> <entry>Value</entry> <entry>Purpose</entry> </row> </thead> <tbody> <row><entry>last-revision</entry><entry>#IMPLIED</e