diff --git a/doc/reference.dtdxml b/doc/reference.dtdxml index 81c0310..035fada 100644 --- a/doc/reference.dtdxml +++ b/doc/reference.dtdxml @@ -21,22 +21,18 @@ -template?, inherit*, purpose?, description?, - (static-constant|typedef|enum| - copy-assignment|constructor|destructor|method-group| - free-function-group|function|method|overloaded-function| - overloaded-method|data-member|class|class-specialization|struct| - struct-specialization|union|union-specialization)* -template?, inherit*, purpose?, description?, - (%boost.class.mix;)* +template?, inherit*, purpose?, description?, + (access|%boost.class.mix;)* +template?, inherit*, purpose?, description?, + (access|%boost.class.mix;)* -purpose?, description?, requires?, effects?, postconditions?, +purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale? -purpose?, description?, requires?, effects?, postconditions?, +purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale? @@ -98,21 +94,26 @@ id CDATA #IMPLIED - static-constant|typedef|enum| copy-assignment|constructor|destructor|method-group| - free-function-group|function|method|overloaded-function| - overloaded-method|data-member|class|class-specialization|struct| + method|overloaded-method|data-member|class|class-specialization|struct| struct-specialization|union|union-specialization static-constant|typedef|enum| copy-assignment|constructor|destructor|method-group| - free-function-group|function|method|overloaded-function| - overloaded-method|data-member|class|class-specialization|struct| + |method|overloaded-method|data-member|class|class-specialization|struct| struct-specialization|union|union-specialization + +free-function-group|function|overloaded-function|%boost.class.members; +free-function-group|function|overloaded-function|%boost.class.members; + + @@ -196,14 +197,10 @@ -template?, specialization?, inherit?, purpose?, description?, - (static-constant|typedef|enum| - copy-assignment|constructor|destructor|method-group| - free-function-group|function|method|overloaded-function| - overloaded-method|data-member|class|class-specialization|struct| - struct-specialization|union|union-specialization)* -template?, specialization?, inherit?, purpose?, description?, - (%boost.class.mix;)* +template?, specialization?, inherit?, purpose?, description?, + (access|%boost.class.mix;)* +template?, specialization?, inherit?, purpose?, description?, + (access|%boost.class.mix;)* + @@ -296,7 +294,7 @@ - + filename CDATA #REQUIRED name CDATA #IMPLIED - + filename CDATA #REQUIRED name CDATA #IMPLIED - + specifiers CDATA #IMPLIED %boost.common.attrib; - + @@ -750,6 +748,7 @@ + @@ -819,10 +818,7 @@ Declares a base class of the enclosing class or struct - This element contains the name of the class inherited. The - content model is free-form, as the inherited class may be an - instantiation of a template and may have markup in it (e.g., - classname tags). + This element contains the type of the class inherited. @@ -837,7 +833,9 @@ + default=""> + The access specifier ("public", "private", or "protected") of the inheritance. + - + 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 @@ -979,12 +977,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. @@ -1218,7 +1216,7 @@ - + specifiers CDATA #IMPLIED %boost.common.attrib; <library-reference> <header name="boost/any.hpp"> - <namespace name="boost"> + <namespace name="boost"> <!-- C++ constructs in the boost namespace --> </namespace> </header> @@ -1496,7 +1494,7 @@ - + name CDATA #REQUIRED %boost.common.attrib; + @@ -1736,7 +1735,7 @@ - + name CDATA #REQUIRED - + filename CDATA #REQUIRED name CDATA #IMPLIED - + cv CDATA #IMPLIED specifiers CDATA #IMPLIED %boost.common.attrib; @@ -2000,7 +1999,7 @@ - + filename CDATA #REQUIRED name CDATA #IMPLIED - + name CDATA #IMPLIED - + name CDATA #REQUIRED %boost.common.attrib; + + + + + + + + + + + + + + + + + + + + + + + + + + + Declares an access specification for class members + + + The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element. + + + + + + name CDATA #REQUIRED + %boost.common.attrib; + + + The name of the access specification, e.g. "public", "private", or "protected". + + + + @@ -2285,6 +2338,7 @@ + @@ -2348,7 +2402,7 @@ inheritance from the class std::bad_cast. It also defines the <purpose> element, which contains a short description of the use of the class. - + <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 @@ -2402,7 +2456,7 @@ - + name CDATA #REQUIRED %boost.common.attrib; - + name CDATA #REQUIRED %boost.common.attrib; + @@ -2874,6 +2929,7 @@ + @@ -3224,5 +3280,4 @@ value="CDATA" default=""/> - diff --git a/doc/reference.xml b/doc/reference.xml index 4c5ab0a..d8340c9 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -1,14 +1,7 @@ - - +
Reference - Elements:Element boostbook - Defines a BoostBook bookElement class - Declares a class or class templateElement class-specialization - A specialization (partial or full) of a class templateElement code - Mimics the code tag in HTMLElement compile-fail-test - A testcase that should fail to compileElement compile-test - A testcase that should compile correctlyElement complexity - The time/space/etc. complexity of a functionElement constructor - Declares a constructor of the enclosing classElement copy-assignment - Declares a copy-assignment operatorElement data-member - Declares a data member of a classElement default - The default value of a function or template parameterElement description - Detailed description of a constructElement destructor - Declares a destructor for the enclosing classElement effects - Declares the side effects of a functionElement enum - Declares an enumeration typeElement enumvalue - A single value of an enumerationElement free-function-group - A set of functions that are grouped together under one nameElement function - Declares a functionElement functionname - References a function with the given nameElement header - Declares a C++ header with the given nameElement if-fails - What it means when a testcase failsElement inherit - Declares a base class of the enclosing class or structElement lib - A library dependencyElement library - Top-level element for a libraryElement library-reference - Declares the reference material for a libraryElement librarycategory - Declares that the enclosing library is in this categoryElement librarycategorydef - Defines a new library categoryElement librarycategorylist - Categorized listing of librariesElement libraryinfo - Provides information about a libraryElement librarylist - Placeholder for an alphabetical list of librariesElement libraryname - References a library of the given nameElement librarypurpose - Describes in one short sentence or phrase the purpose of a libraryElement link-fail-test - Declares a test that should compile but fail to linkElement link-test - Declares a test that should compile and linkElement method - Declares a method, i.e., a member functionElement method-group - A set of methods that are grouped together under one nameElement namespace - Declares a namespaceElement notes - Non-normative notes about a function's semanticsElement overloaded-function - An overloaded functionElement overloaded-method - An overloaded methodElement parameter - A function parameterElement paramtype - The type of a function parameterElement postconditions - Conditions that must hold after the function returnsElement precondition - Conditions that must be met prior to executing a functionElement programlisting - A sample of program codeElement purpose - A short description of an entity's useElement rationale - Describes the rationale for a particular function's designElement requirement - A requirement/property in the Jamfile for a testcaseElement requires - Declares the requirements of a functionElement returns - Description of the return value of a functionElement run-fail-test - A testcase that should compile and link, but fail on executionElement run-test - A testcase that should compile, link, and executeElement signature - One signature of an overloaded function or methodElement snippet - Pulls in a code snippet from a programlisting elementElement source - Defines source code for a testElement specialization - Defines the specialization arguments for a class specializationElement static-constant - Declares a static constant, e.g., const int foo = 5;.Element struct - Declares a C++ structElement struct-specialization - A specialization (full or partial) of a struct templateElement template - Declares the template parameters of a class or functionElement template-arg - A template argument in a specializationElement template-nontype-parameter - A nontype template parameterElement template-type-parameter - Declares a template type parameterElement template-varargs - Declares a variable-length list of template parametersElement testsuite - Describes a library testsuiteElement throws - Description of the exceptions thrown by a functionElement type - The type of an element or return type of a functionElement typedef - Declares a typedefElement union - Declares a C++ union or union templateElement union-specialization - A specialization (full or partial) of a union templateElement using-class - Injects the method and function names of a class into the local scopeElement using-namespace - Injects the declared names from a namespace into the local scope + Elements:Element access - Declares an access specification for class membersElement boostbook - Defines a BoostBook bookElement class - Declares a class or class templateElement class-specialization - A specialization (partial or full) of a class templateElement code - Mimics the code tag in HTMLElement compile-fail-test - A testcase that should fail to compileElement compile-test - A testcase that should compile correctlyElement complexity - The time/space/etc. complexity of a functionElement constructor - Declares a constructor of the enclosing classElement copy-assignment - Declares a copy-assignment operatorElement data-member - Declares a data member of a classElement default - The default value of a function or template parameterElement description - Detailed description of a constructElement destructor - Declares a destructor for the enclosing classElement effects - Declares the side effects of a functionElement enum - Declares an enumeration typeElement enumvalue - A single value of an enumerationElement free-function-group - A set of functions that are grouped together under one nameElement function - Declares a functionElement functionname - References a function with the given nameElement header - Declares a C++ header with the given nameElement if-fails - What it means when a testcase failsElement inherit - Declares a base class of the enclosing class or structElement lib - A library dependencyElement library - Top-level element for a libraryElement library-reference - Declares the reference material for a libraryElement librarycategory - Declares that the enclosing library is in this categoryElement librarycategorydef - Defines a new library categoryElement librarycategorylist - Categorized listing of librariesElement libraryinfo - Provides information about a libraryElement librarylist - Placeholder for an alphabetical list of librariesElement libraryname - References a library of the given nameElement librarypurpose - Describes in one short sentence or phrase the purpose of a libraryElement link-fail-test - Declares a test that should compile but fail to linkElement link-test - Declares a test that should compile and linkElement method - Declares a method, i.e., a member functionElement method-group - A set of methods that are grouped together under one nameElement namespace - Declares a namespaceElement notes - Non-normative notes about a function's semanticsElement overloaded-function - An overloaded functionElement overloaded-method - An overloaded methodElement parameter - A function parameterElement paramtype - The type of a function parameterElement postconditions - Conditions that must hold after the function returnsElement precondition - Conditions that must be met prior to executing a functionElement programlisting - A sample of program codeElement purpose - A short description of an entity's useElement rationale - Describes the rationale for a particular function's designElement requirement - A requirement/property in the Jamfile for a testcaseElement requires - Declares the requirements of a functionElement returns - Description of the return value of a functionElement run-fail-test - A testcase that should compile and link, but fail on executionElement run-test - A testcase that should compile, link, and executeElement signature - One signature of an overloaded function or methodElement snippet - Pulls in a code snippet from a programlisting elementElement source - Defines source code for a testElement specialization - Defines the specialization arguments for a class specializationElement static-constant - Declares a static constant, e.g., const int foo = 5;.Element struct - Declares a C++ structElement struct-specialization - A specialization (full or partial) of a struct templateElement template - Declares the template parameters of a class or functionElement template-arg - A template argument in a specializationElement template-nontype-parameter - A nontype template parameterElement template-type-parameter - Declares a template type parameterElement template-varargs - Declares a variable-length list of template parametersElement testsuite - Describes a library testsuiteElement throws - Description of the exceptions thrown by a functionElement type - The type of an element or return type of a functionElement typedef - Declares a typedefElement union - Declares a C++ union or union templateElement union-specialization - A specialization (full or partial) of a union templateElement using-class - Injects the method and function names of a class into the local scopeElement using-namespace - Injects the declared names from a namespace into the local scope @@ -20,7 +13,7 @@ A specialization (partial or full) of a class template class-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -36,7 +29,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -140,7 +133,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -176,7 +169,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -218,7 +211,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -258,7 +251,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -294,7 +287,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -339,7 +332,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -377,7 +370,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -413,7 +406,7 @@ this: <library-reference> - <header name="boost/any.hpp"> + <header name="boost/any.hpp"> <!-- C++ constructs in this header --> </header> </library-reference> @@ -440,7 +433,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -480,7 +473,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -499,7 +492,7 @@ Declares a C++ union or union template union ::= - (template?, inherit*, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -515,7 +508,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -535,13 +528,10 @@ Declares a base class of the enclosing class or struct inherit ::= - (ANY) + (type, purpose?) Description - This element contains the name of the class inherited. The - content model is free-form, as the inherited class may be an - instantiation of a template and may have markup in it (e.g., - classname tags). + This element contains the type of the class inherited. Attributes @@ -557,8 +547,8 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes -access#REQUIREDCDATA +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +access#REQUIREDCDATAThe access specifier ("public", "private", or "protected") of the inheritance. id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -582,7 +572,7 @@ Description 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 + allowed in BoostBook. This element generally expands to "..." and can be used anywhere any other template parameter can be used. @@ -600,7 +590,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -654,7 +644,7 @@ behavior. Constructors, destructors, member functions, and free functions all use the same documentation method, although the top-level tags differ. - + 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 @@ -662,18 +652,18 @@ The following example illustrates some constructors and a destructor for boost::any. Note that one of - the constructors takes a single parameter whose name is "other" and + the constructors takes a single parameter whose name is "other" and whose type, const any& is contained in the <paramtype> element; any number of parameters may be specified in this way. - <class name="any"> + <class name="any"> <constructor> <postconditions><para><this->empty()></para></postconditions> </constructor> <constructor> - <parameter name="other"> + <parameter name="other"> <paramtype>const <classname>any</classname>&amp;</paramtype> </parameter> @@ -683,12 +673,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. @@ -718,7 +708,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element @@ -755,7 +745,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -829,7 +819,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. name#REQUIREDCDATAThe name of the element being declared to referenced @@ -905,7 +895,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -932,12 +922,12 @@ element. As in C++, namespaces can be nested and contain other C++ constructs, such as classes or functions. The name attribute of a <namespace> element gives the namespace name - (e.g., "boost"). The Any library is + (e.g., "boost"). The Any library is defined entirely within namespace boost by: <library-reference> - <header name="boost/any.hpp"> - <namespace name="boost"> + <header name="boost/any.hpp"> + <namespace name="boost"> <!-- C++ constructs in the boost namespace --> </namespace> </header> @@ -957,7 +947,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1016,7 +1006,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1060,7 +1050,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1095,7 +1085,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1131,7 +1121,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1166,7 +1156,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1202,7 +1192,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1221,7 +1211,7 @@ A specialization (full or partial) of a union template union-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -1237,7 +1227,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1273,7 +1263,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1308,7 +1298,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1343,7 +1333,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1372,7 +1362,7 @@ requirement gives the value of that feature. A requirement such as <includes>foo.hpp would be encoded as <requirement - name="includes">foo.hpp</requirement>. + name="includes">foo.hpp</requirement>. Attributes @@ -1421,7 +1411,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1456,7 +1446,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1491,7 +1481,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1561,7 +1551,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1605,7 +1595,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. id#IMPLIEDCDATAA global identifier for this element @@ -1676,7 +1666,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1745,7 +1735,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1780,7 +1770,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1857,7 +1847,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. id#IMPLIEDCDATAA global identifier for this element @@ -1899,7 +1889,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1908,6 +1898,44 @@ + + + + BoostBook element access + 9 + + + access + Declares an access specification for class members + + access ::= + (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ + + Description + The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element. + + + Attributes + + + + + Name + Type + Value + Purpose + + + + + last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes + name#REQUIREDCDATAThe name of the access specification, e.g. "public", "private", or "protected". + id#IMPLIEDCDATAA global identifier for this element + + + + + @@ -1919,18 +1947,18 @@ Declares a class or class template class ::= - (template?, inherit*, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Description C++ classes and class templates are described via the - <class> element. Each class has a name (e.g., "any") given by + <class> element. Each class has a name (e.g., "any") given by the name attribute, a purpose given by the <purpose> element, documentation, and a set of types, functions, base classes, and data members. Here is a minimal definition of the boost::any class: - <namespace name="boost"> - <class name="any"> + <namespace name="boost"> + <class name="any"> <purpose> A class whose instances can hold instances of any type that satisfies ValueType requirements. @@ -1955,9 +1983,9 @@ inheritance from the class std::bad_cast. It also defines the <purpose> element, which contains a short description of the use of the class. - - <class name="bad_any_cast"> - <inherit access="public"><classname>std::bad_cast</classname></inherit> + + <class name="bad_any_cast"> + <inherit access="public"><classname>std::bad_cast</classname></inherit> <purpose><para>The exception thrown in the event of a failed <functionname>any_cast</functionname> of an <classname>any</classname> value.</para></purpose> @@ -1980,7 +2008,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2003,7 +2031,7 @@ (#PCDATA) Description - All library category definitions should be in doc/src/boost.xml, and the names of categories must be prefixed with "category:". + All library category definitions should be in doc/src/boost.xml, and the names of categories must be prefixed with "category:". Attributes @@ -2019,7 +2047,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2055,7 +2083,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2090,7 +2118,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2131,7 +2159,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2200,7 +2228,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2235,7 +2263,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2270,7 +2298,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2306,7 +2334,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes dirname#REQUIREDCDATA url#IMPLIEDCDATA name#REQUIREDCDATAThe name of the element being declared to referenced @@ -2350,7 +2378,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2385,7 +2413,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2405,7 +2433,7 @@ A specialization (full or partial) of a struct template struct-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -2421,7 +2449,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2441,7 +2469,7 @@ Declares a C++ struct struct ::= - (template?, inherit*, purpose?, description?, (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -2457,7 +2485,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2510,7 +2538,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2546,7 +2574,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2581,7 +2609,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2616,7 +2644,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2651,7 +2679,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2686,7 +2714,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2721,7 +2749,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2757,7 +2785,7 @@ -last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -2765,4 +2793,4 @@ - +
diff --git a/dtd/boostbook.dtd b/dtd/boostbook.dtd index 9a94f9c..7cd2436 100644 --- a/dtd/boostbook.dtd +++ b/dtd/boostbook.dtd @@ -1,15 +1,20 @@ @@ -209,7 +221,7 @@ %boost.common.attrib;> - @@ -229,12 +241,12 @@ %boost.common.attrib;> - - @@ -252,12 +264,12 @@ %boost.common.attrib;> - - @@ -286,12 +298,12 @@ - - @@ -301,9 +313,9 @@ - - @@ -330,7 +342,7 @@ %boost.common.attrib;> - - - @@ -360,12 +372,12 @@ name CDATA #IMPLIED> - - @@ -378,13 +390,13 @@ - - @@ -393,7 +405,7 @@ - @@ -408,5 +420,5 @@ - + %DocBook; diff --git a/xsl/chunk-common.xsl b/xsl/chunk-common.xsl index 24a808e..e79e534 100644 --- a/xsl/chunk-common.xsl +++ b/xsl/chunk-common.xsl @@ -1,7 +1,7 @@ @@ -148,7 +148,7 @@ - + ( @@ -168,21 +168,21 @@ - - - + - - + @@ -249,17 +249,17 @@ ( - - + ) - ; + ; @@ -320,11 +320,11 @@ ( - - + ) @@ -332,7 +332,7 @@ ; - + @@ -394,18 +394,18 @@ - - - - @@ -423,7 +423,7 @@ - @@ -441,7 +441,7 @@ - @@ -460,10 +460,10 @@ - - @@ -479,7 +479,7 @@ @@ -524,7 +524,7 @@ @@ -537,7 +537,7 @@ - + // @@ -566,7 +566,7 @@ - + @@ -598,7 +598,7 @@ - + // @@ -634,8 +634,12 @@ - + + + + + construct/copy/destruct @@ -658,7 +662,9 @@ - + + + @@ -668,7 +674,7 @@ - + @@ -678,7 +684,9 @@ - + + + @@ -698,7 +706,9 @@ - + + + @@ -826,7 +836,7 @@ @@ -856,7 +866,7 @@ @@ -891,8 +901,8 @@ - - + + @@ -901,9 +911,9 @@ - + @@ -911,7 +921,7 @@ - + @@ -935,7 +945,7 @@ @@ -975,8 +985,8 @@ - - + + @@ -988,7 +998,7 @@ - + @@ -1025,7 +1035,7 @@ - @@ -1044,7 +1054,9 @@ - + + + @@ -1057,7 +1069,7 @@ - + @@ -1105,5 +1117,5 @@ - + diff --git a/xsl/lookup.xsl b/xsl/lookup.xsl index fbed12a..4e1cc8d 100644 --- a/xsl/lookup.xsl +++ b/xsl/lookup.xsl @@ -1,7 +1,7 @@ @@ -157,7 +157,7 @@ - @@ -279,16 +279,16 @@ $context/ancestor::*/using-class | $context/ancestor::class | $context/ancestor::struct"/> - + - + - - + @@ -306,7 +306,7 @@ - + @@ -324,7 +324,7 @@ - + @@ -338,12 +338,12 @@ - - + @@ -372,19 +372,19 @@ - + - + - + - + diff --git a/xsl/reference.xsl b/xsl/reference.xsl index beec99e..4b4d0b6 100644 --- a/xsl/reference.xsl +++ b/xsl/reference.xsl @@ -1,7 +1,7 @@ @@ -32,7 +32,7 @@ { - + - + - - + - + @@ -89,7 +89,7 @@ diff --git a/xsl/type.xsl b/xsl/type.xsl index be0a088..2fbd977 100644 --- a/xsl/type.xsl +++ b/xsl/type.xsl @@ -659,7 +659,9 @@ Unknown type element "" in type.display.na - + + + @@ -669,7 +671,9 @@ Unknown type element "" in type.display.na - + + + @@ -679,90 +683,15 @@ Unknown type element "" in type.display.na - + + + - + - - - - - - - - - - - - - - - - // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - { - - - - - - - - - - - - - : - - @@ -836,6 +765,121 @@ Unknown type element "" in type.display.na + + + + + + + + + + + + + : + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + // + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + { + + + + + + + + + + + + + + + + + + + @@ -856,6 +900,30 @@ Unknown type element "" in type.display.na + + + + + + + + + + + + + + + + " in type.display.na - - - - - - - - - - - + + diff --git a/xsl/utility.xsl b/xsl/utility.xsl index be6f53e..f0edc47 100644 --- a/xsl/utility.xsl +++ b/xsl/utility.xsl @@ -1,7 +1,7 @@ + + + + + + + + + + + + + public + + + +