|
|
Boost-Commit : |
From: fmhess_at_[hidden]
Date: 2007-09-12 10:44:28
Author: fmhess
Date: 2007-09-12 10:44:27 EDT (Wed, 12 Sep 2007)
New Revision: 39218
URL: http://svn.boost.org/trac/boost/changeset/39218
Log:
Inserted some newlines to break up extremely long single line containing
an itemized list.
Text files modified:
sandbox/boost_docs/trunk/tools/boostbook/doc/reference.xml | 233 ++++++++++++++++++++++++++-------------
1 files changed, 154 insertions(+), 79 deletions(-)
Modified: sandbox/boost_docs/trunk/tools/boostbook/doc/reference.xml
==============================================================================
--- sandbox/boost_docs/trunk/tools/boostbook/doc/reference.xml (original)
+++ sandbox/boost_docs/trunk/tools/boostbook/doc/reference.xml 2007-09-12 10:44:27 EDT (Wed, 12 Sep 2007)
@@ -1,14 +1,89 @@
<?xml version="1.0" standalone="yes"?>
<!--
Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
-
+
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
-->
<section id="reference">
<title>Reference</title>
- <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 descripti
on 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></lis
titem><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-refer
ence">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><listit
em><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 to
gether 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 lin
kend="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>pro
gramlisting</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><simp
ara><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><lis
titem><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>
+ <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>
<refentry id="boostbook.dtd.class-specialization">
<refmeta>
<refentrytitle>
@@ -19,7 +94,7 @@
<refname>class-specialization</refname>
<refpurpose>A specialization (partial or full) of a class template</refpurpose>
</refnamediv>
- <refsynopsisdiv>class-specialization ::=
+ <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.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.dt
d.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>
@@ -55,7 +130,7 @@
<refname>link-test</refname>
<refpurpose>Declares a test that should compile and link</refpurpose>
</refnamediv>
- <refsynopsisdiv>link-test ::=
+ <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>
@@ -89,7 +164,7 @@
<refname>link-fail-test</refname>
<refpurpose>Declares a test that should compile but fail to link</refpurpose>
</refnamediv>
- <refsynopsisdiv>link-fail-test ::=
+ <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>
@@ -123,7 +198,7 @@
<refname>typedef</refname>
<refpurpose>Declares a typedef</refpurpose>
</refnamediv>
- <refsynopsisdiv>typedef ::=
+ <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>
@@ -159,7 +234,7 @@
<refname>static-constant</refname>
<refpurpose>Declares a static constant, e.g., <code>const int foo = 5;</code>.</refpurpose>
</refnamediv>
- <refsynopsisdiv>static-constant ::=
+ <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>
@@ -195,7 +270,7 @@
<refname>code</refname>
<refpurpose>Mimics the <sgmltag>code</sgmltag> tag in HTML</refpurpose>
</refnamediv>
- <refsynopsisdiv>code ::=
+ <refsynopsisdiv>code ::=
(ANY)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -236,7 +311,7 @@
<refname>destructor</refname>
<refpurpose>Declares a destructor for the enclosing class</refpurpose>
</refnamediv>
- <refsynopsisdiv>destructor ::=
+ <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>
@@ -277,7 +352,7 @@
<refname>template-type-parameter</refname>
<refpurpose>Declares a template type parameter</refpurpose>
</refnamediv>
- <refsynopsisdiv>template-type-parameter ::=
+ <refsynopsisdiv>template-type-parameter ::=
(<link linkend="boostbook.dtd.default">default</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection>
@@ -313,7 +388,7 @@
<refname>description</refname>
<refpurpose>Detailed description of a construct</refpurpose>
</refnamediv>
- <refsynopsisdiv>description ::=
+ <refsynopsisdiv>description ::=
(ANY)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -357,7 +432,7 @@
<refname>librarylist</refname>
<refpurpose>Placeholder for an alphabetical list of libraries</refpurpose>
</refnamediv>
- <refsynopsisdiv>librarylist ::=
+ <refsynopsisdiv>librarylist ::=
EMPTY
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -395,7 +470,7 @@
<refname>library-reference</refname>
<refpurpose>Declares the reference material for a library</refpurpose>
</refnamediv>
- <refsynopsisdiv>library-reference ::=
+ <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>
@@ -458,7 +533,7 @@
<refname>boostbook</refname>
<refpurpose>Defines a BoostBook book</refpurpose>
</refnamediv>
- <refsynopsisdiv>boostbook ::=
+ <refsynopsisdiv>boostbook ::=
(title, (chapter| <link linkend="boostbook.dtd.library">library</link>)*)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -498,7 +573,7 @@
<refname>union</refname>
<refpurpose>Declares a C++ union or union template</refpurpose>
</refnamediv>
- <refsynopsisdiv>union ::=
+ <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.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="boostbo
ok.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>
@@ -534,7 +609,7 @@
<refname>inherit</refname>
<refpurpose>Declares a base class of the enclosing class or struct</refpurpose>
</refnamediv>
- <refsynopsisdiv>inherit ::=
+ <refsynopsisdiv>inherit ::=
(ANY)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -576,7 +651,7 @@
<refname>template-varargs</refname>
<refpurpose>Declares a variable-length list of template parameters</refpurpose>
</refnamediv>
- <refsynopsisdiv>template-varargs ::=
+ <refsynopsisdiv>template-varargs ::=
EMPTY
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -618,7 +693,7 @@
<refname>source</refname>
<refpurpose>Defines source code for a test</refpurpose>
</refnamediv>
- <refsynopsisdiv>source ::=
+ <refsynopsisdiv>source ::=
(#PCDATA| <link linkend="boostbook.dtd.snippet">snippet</link>)*
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -645,7 +720,7 @@
<refname>function</refname>
<refpurpose>Declares a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>function ::=
+ <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>
@@ -654,7 +729,7 @@
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
@@ -683,12 +758,12 @@
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.
+ empty.
</simpara>
</effects>
<throws>
- <simpara>May fail with a
+ <simpara>May fail with a
<classname>std::bad_alloc</classname> exception or any
exceptions arising from the copy constructor of the
contained type.
@@ -738,7 +813,7 @@
<refname>postconditions</refname>
<refpurpose>Conditions that must hold after the function returns</refpurpose>
</refnamediv>
- <refsynopsisdiv>postconditions ::=
+ <refsynopsisdiv>postconditions ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -773,7 +848,7 @@
<refname>compile-test</refname>
<refpurpose>A testcase that should compile correctly</refpurpose>
</refnamediv>
- <refsynopsisdiv>compile-test ::=
+ <refsynopsisdiv>compile-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>
@@ -807,7 +882,7 @@
<refname>method</refname>
<refpurpose>Declares a method, i.e., a member function</refpurpose>
</refnamediv>
- <refsynopsisdiv>method ::=
+ <refsynopsisdiv>method ::=
(<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>
@@ -850,7 +925,7 @@
<refname>snippet</refname>
<refpurpose>Pulls in a code snippet from a <sgmltag>programlisting</sgmltag> element</refpurpose>
</refnamediv>
- <refsynopsisdiv>snippet ::=
+ <refsynopsisdiv>snippet ::=
EMPTY
</refsynopsisdiv>
<refsection>
@@ -883,7 +958,7 @@
<refname>constructor</refname>
<refpurpose>Declares a constructor of the enclosing class</refpurpose>
</refnamediv>
- <refsynopsisdiv>constructor ::=
+ <refsynopsisdiv>constructor ::=
(<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>?)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -924,7 +999,7 @@
<refname>namespace</refname>
<refpurpose>Declares a namespace</refpurpose>
</refnamediv>
- <refsynopsisdiv>namespace ::=
+ <refsynopsisdiv>namespace ::=
(<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>)*
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -937,7 +1012,7 @@
<programlisting><library-reference>
<header name="boost/any.hpp">
- <namespace name="boost">
+ <namespace name="boost">
<!-- C++ constructs in the boost namespace -->
</namespace>
</header>
@@ -976,7 +1051,7 @@
<refname>if-fails</refname>
<refpurpose>What it means when a testcase fails</refpurpose>
</refnamediv>
- <refsynopsisdiv>if-fails ::=
+ <refsynopsisdiv>if-fails ::=
(ANY)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -999,7 +1074,7 @@
<refname>free-function-group</refname>
<refpurpose>A set of functions that are grouped together under one name</refpurpose>
</refnamediv>
- <refsynopsisdiv>free-function-group ::=
+ <refsynopsisdiv>free-function-group ::=
(<link linkend="boostbook.dtd.function">function</link>| <link linkend="boostbook.dtd.overloaded-function">overloaded-function</link>)*
</refsynopsisdiv>
<refsection>
@@ -1035,7 +1110,7 @@
<refname>functionname</refname>
<refpurpose>References a function with the given name</refpurpose>
</refnamediv>
- <refsynopsisdiv>functionname ::=
+ <refsynopsisdiv>functionname ::=
(#PCDATA)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -1078,7 +1153,7 @@
<refname>librarycategory</refname>
<refpurpose>Declares that the enclosing library is in this category</refpurpose>
</refnamediv>
- <refsynopsisdiv>librarycategory ::=
+ <refsynopsisdiv>librarycategory ::=
(#PCDATA)
</refsynopsisdiv>
<refsection>
@@ -1114,7 +1189,7 @@
<refname>notes</refname>
<refpurpose>Non-normative notes about a function's semantics</refpurpose>
</refnamediv>
- <refsynopsisdiv>notes ::=
+ <refsynopsisdiv>notes ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1149,7 +1224,7 @@
<refname>data-member</refname>
<refpurpose>Declares a data member of a class</refpurpose>
</refnamediv>
- <refsynopsisdiv>data-member ::=
+ <refsynopsisdiv>data-member ::=
(<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
</refsynopsisdiv>
<refsection>
@@ -1185,7 +1260,7 @@
<refname>specialization</refname>
<refpurpose>Defines the specialization arguments for a class specialization</refpurpose>
</refnamediv>
- <refsynopsisdiv>specialization ::=
+ <refsynopsisdiv>specialization ::=
(<link linkend="boostbook.dtd.template-arg">template-arg</link>)*
</refsynopsisdiv>
<refsection>
@@ -1220,7 +1295,7 @@
<refname>union-specialization</refname>
<refpurpose>A specialization (full or partial) of a union template</refpurpose>
</refnamediv>
- <refsynopsisdiv>union-specialization ::=
+ <refsynopsisdiv>union-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.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.dt
d.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>
@@ -1256,7 +1331,7 @@
<refname>throws</refname>
<refpurpose>Description of the exceptions thrown by a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>throws ::=
+ <refsynopsisdiv>throws ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1291,7 +1366,7 @@
<refname>template-arg</refname>
<refpurpose>A template argument in a specialization</refpurpose>
</refnamediv>
- <refsynopsisdiv>template-arg ::=
+ <refsynopsisdiv>template-arg ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1326,7 +1401,7 @@
<refname>method-group</refname>
<refpurpose>A set of methods that are grouped together under one name</refpurpose>
</refnamediv>
- <refsynopsisdiv>method-group ::=
+ <refsynopsisdiv>method-group ::=
(<link linkend="boostbook.dtd.method">method</link>| <link linkend="boostbook.dtd.overloaded-method">overloaded-method</link>)*
</refsynopsisdiv>
<refsection>
@@ -1362,7 +1437,7 @@
<refname>requirement</refname>
<refpurpose>A requirement/property in the Jamfile for a testcase</refpurpose>
</refnamediv>
- <refsynopsisdiv>requirement ::=
+ <refsynopsisdiv>requirement ::=
(#PCDATA)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -1404,7 +1479,7 @@
<refname>precondition</refname>
<refpurpose>Conditions that must be met prior to executing a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>precondition ::=
+ <refsynopsisdiv>precondition ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1439,7 +1514,7 @@
<refname>paramtype</refname>
<refpurpose>The type of a function parameter</refpurpose>
</refnamediv>
- <refsynopsisdiv>paramtype ::=
+ <refsynopsisdiv>paramtype ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1474,7 +1549,7 @@
<refname>using-class</refname>
<refpurpose>Injects the method and function names of a class into the local scope</refpurpose>
</refnamediv>
- <refsynopsisdiv>using-class ::=
+ <refsynopsisdiv>using-class ::=
EMPTY
</refsynopsisdiv>
<refsection>
@@ -1510,7 +1585,7 @@
<refname>run-test</refname>
<refpurpose>A testcase that should compile, link, and execute</refpurpose>
</refnamediv>
- <refsynopsisdiv>run-test ::=
+ <refsynopsisdiv>run-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>
@@ -1544,7 +1619,7 @@
<refname>librarypurpose</refname>
<refpurpose>Describes in one short sentence or phrase the purpose of a library</refpurpose>
</refnamediv>
- <refsynopsisdiv>librarypurpose ::=
+ <refsynopsisdiv>librarypurpose ::=
(#PCDATA| <link linkend="boostbook.dtd.code">code</link>| ulink| <link linkend="boostbook.dtd.functionname">functionname</link>| methodname| classname)*
</refsynopsisdiv>
<refsection>
@@ -1579,7 +1654,7 @@
<refname>copy-assignment</refname>
<refpurpose>Declares a copy-assignment operator</refpurpose>
</refnamediv>
- <refsynopsisdiv>copy-assignment ::=
+ <refsynopsisdiv>copy-assignment ::=
(<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>
@@ -1625,7 +1700,7 @@
<refname>run-fail-test</refname>
<refpurpose>A testcase that should compile and link, but fail on execution</refpurpose>
</refnamediv>
- <refsynopsisdiv>run-fail-test ::=
+ <refsynopsisdiv>run-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>
@@ -1659,7 +1734,7 @@
<refname>template</refname>
<refpurpose>Declares the template parameters of a class or function</refpurpose>
</refnamediv>
- <refsynopsisdiv>template ::=
+ <refsynopsisdiv>template ::=
(<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>)*
</refsynopsisdiv>
<refsection>
@@ -1694,7 +1769,7 @@
<refname>compile-fail-test</refname>
<refpurpose>A testcase that should fail to compile</refpurpose>
</refnamediv>
- <refsynopsisdiv>compile-fail-test ::=
+ <refsynopsisdiv>compile-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>
@@ -1728,7 +1803,7 @@
<refname>returns</refname>
<refpurpose>Description of the return value of a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>returns ::=
+ <refsynopsisdiv>returns ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1763,7 +1838,7 @@
<refname>default</refname>
<refpurpose>The default value of a function or template parameter</refpurpose>
</refnamediv>
- <refsynopsisdiv>default ::=
+ <refsynopsisdiv>default ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -1798,7 +1873,7 @@
<refname>parameter</refname>
<refpurpose>A function parameter</refpurpose>
</refnamediv>
- <refsynopsisdiv>parameter ::=
+ <refsynopsisdiv>parameter ::=
(<link linkend="boostbook.dtd.paramtype">paramtype</link>, <link linkend="boostbook.dtd.default">default</link>?)
</refsynopsisdiv>
<refsection>
@@ -1831,7 +1906,7 @@
<refname>signature</refname>
<refpurpose>One signature of an overloaded function or method</refpurpose>
</refnamediv>
- <refsynopsisdiv>signature ::=
+ <refsynopsisdiv>signature ::=
(<link linkend="boostbook.dtd.template">template</link>?, <link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.parameter">parameter</link>*)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -1877,7 +1952,7 @@
<refname>overloaded-function</refname>
<refpurpose>An overloaded function</refpurpose>
</refnamediv>
- <refsynopsisdiv>overloaded-function ::=
+ <refsynopsisdiv>overloaded-function ::=
(<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>?)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -1918,7 +1993,7 @@
<refname>class</refname>
<refpurpose>Declares a class or class template</refpurpose>
</refnamediv>
- <refsynopsisdiv>class ::=
+ <refsynopsisdiv>class ::=
(<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="boostbo
ok.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>Description</title>
@@ -1955,7 +2030,7 @@
inheritance from the class <classname>std::bad_cast</classname>. It
also defines the <purpose> element, which contains a short
description of the use of the class.</para>
-
+
<programlisting><class name="bad_any_cast">
<inherit access="public"><classname>std::bad_cast</classname></inherit>
<purpose><para>The exception thrown in the event of a failed
@@ -1999,7 +2074,7 @@
<refname>librarycategorydef</refname>
<refpurpose>Defines a new library category</refpurpose>
</refnamediv>
- <refsynopsisdiv>librarycategorydef ::=
+ <refsynopsisdiv>librarycategorydef ::=
(#PCDATA)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -2038,7 +2113,7 @@
<refname>type</refname>
<refpurpose>The type of an element or return type of a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>type ::=
+ <refsynopsisdiv>type ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2073,7 +2148,7 @@
<refname>enumvalue</refname>
<refpurpose>A single value of an enumeration</refpurpose>
</refnamediv>
- <refsynopsisdiv>enumvalue ::=
+ <refsynopsisdiv>enumvalue ::=
(<link linkend="boostbook.dtd.default">default</link>?)
</refsynopsisdiv>
<refsection>
@@ -2109,7 +2184,7 @@
<refname>overloaded-method</refname>
<refpurpose>An overloaded method</refpurpose>
</refnamediv>
- <refsynopsisdiv>overloaded-method ::=
+ <refsynopsisdiv>overloaded-method ::=
(<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>?)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -2150,7 +2225,7 @@
<refname>programlisting</refname>
<refpurpose>A sample of program code</refpurpose>
</refnamediv>
- <refsynopsisdiv>programlisting ::=
+ <refsynopsisdiv>programlisting ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2183,7 +2258,7 @@
<refname>complexity</refname>
<refpurpose>The time/space/etc. complexity of a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>complexity ::=
+ <refsynopsisdiv>complexity ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2218,7 +2293,7 @@
<refname>purpose</refname>
<refpurpose>A short description of an entity's use</refpurpose>
</refnamediv>
- <refsynopsisdiv>purpose ::=
+ <refsynopsisdiv>purpose ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2253,7 +2328,7 @@
<refname>template-nontype-parameter</refname>
<refpurpose>A nontype template parameter</refpurpose>
</refnamediv>
- <refsynopsisdiv>template-nontype-parameter ::=
+ <refsynopsisdiv>template-nontype-parameter ::=
(<link linkend="boostbook.dtd.type">type</link>, <link linkend="boostbook.dtd.default">default</link>?, <link linkend="boostbook.dtd.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection>
@@ -2289,7 +2364,7 @@
<refname>library</refname>
<refpurpose>Top-level element for a library</refpurpose>
</refnamediv>
- <refsynopsisdiv>library ::=
+ <refsynopsisdiv>library ::=
(<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>))+)?)
</refsynopsisdiv>
<refsection>
@@ -2328,7 +2403,7 @@
<refname>librarycategorylist</refname>
<refpurpose>Categorized listing of libraries</refpurpose>
</refnamediv>
- <refsynopsisdiv>librarycategorylist ::=
+ <refsynopsisdiv>librarycategorylist ::=
(<link linkend="boostbook.dtd.librarycategorydef">librarycategorydef</link>)*
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -2368,7 +2443,7 @@
<refname>using-namespace</refname>
<refpurpose>Injects the declared names from a namespace into the local scope</refpurpose>
</refnamediv>
- <refsynopsisdiv>using-namespace ::=
+ <refsynopsisdiv>using-namespace ::=
EMPTY
</refsynopsisdiv>
<refsection>
@@ -2404,7 +2479,7 @@
<refname>struct-specialization</refname>
<refpurpose>A specialization (full or partial) of a struct template</refpurpose>
</refnamediv>
- <refsynopsisdiv>struct-specialization ::=
+ <refsynopsisdiv>struct-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.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.dt
d.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>
@@ -2440,7 +2515,7 @@
<refname>struct</refname>
<refpurpose>Declares a C++ struct</refpurpose>
</refnamediv>
- <refsynopsisdiv>struct ::=
+ <refsynopsisdiv>struct ::=
(<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="boostbo
ok.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>
@@ -2476,7 +2551,7 @@
<refname>lib</refname>
<refpurpose>A library dependency</refpurpose>
</refnamediv>
- <refsynopsisdiv>lib ::=
+ <refsynopsisdiv>lib ::=
(#PCDATA)
</refsynopsisdiv>
<refsection><title>Description</title>
@@ -2493,7 +2568,7 @@
<refname>enum</refname>
<refpurpose>Declares an enumeration type</refpurpose>
</refnamediv>
- <refsynopsisdiv>enum ::=
+ <refsynopsisdiv>enum ::=
(<link linkend="boostbook.dtd.enumvalue">enumvalue</link>*, <link linkend="boostbook.dtd.purpose">purpose</link>?, <link linkend="boostbook.dtd.description">description</link>?)
</refsynopsisdiv>
<refsection>
@@ -2529,7 +2604,7 @@
<refname>requires</refname>
<refpurpose>Declares the requirements of a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>requires ::=
+ <refsynopsisdiv>requires ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2564,7 +2639,7 @@
<refname>effects</refname>
<refpurpose>Declares the side effects of a function</refpurpose>
</refnamediv>
- <refsynopsisdiv>effects ::=
+ <refsynopsisdiv>effects ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2599,7 +2674,7 @@
<refname>libraryname</refname>
<refpurpose>References a library of the given name</refpurpose>
</refnamediv>
- <refsynopsisdiv>libraryname ::=
+ <refsynopsisdiv>libraryname ::=
(#PCDATA)
</refsynopsisdiv>
<refsection>
@@ -2634,7 +2709,7 @@
<refname>libraryinfo</refname>
<refpurpose>Provides information about a library</refpurpose>
</refnamediv>
- <refsynopsisdiv>libraryinfo ::=
+ <refsynopsisdiv>libraryinfo ::=
(author+, copyright*, legalnotice*, <link linkend="boostbook.dtd.librarypurpose">librarypurpose</link>, <link linkend="boostbook.dtd.librarycategory">librarycategory</link>*)
</refsynopsisdiv>
<refsection>
@@ -2669,7 +2744,7 @@
<refname>testsuite</refname>
<refpurpose>Describes a library testsuite</refpurpose>
</refnamediv>
- <refsynopsisdiv>testsuite ::=
+ <refsynopsisdiv>testsuite ::=
((<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>)+)
</refsynopsisdiv>
<refsection>
@@ -2704,7 +2779,7 @@
<refname>header</refname>
<refpurpose>Declares a C++ header with the given name</refpurpose>
</refnamediv>
- <refsynopsisdiv>header ::=
+ <refsynopsisdiv>header ::=
(ANY)
</refsynopsisdiv>
<refsection>
@@ -2740,7 +2815,7 @@
<refname>rationale</refname>
<refpurpose>Describes the rationale for a particular function's design</refpurpose>
</refnamediv>
- <refsynopsisdiv>rationale ::=
+ <refsynopsisdiv>rationale ::=
(ANY)
</refsynopsisdiv>
<refsection>
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk