diff --git a/doc/reference.dtdxml b/doc/reference.dtdxml index b013579..8c7c720 100644 --- a/doc/reference.dtdxml +++ b/doc/reference.dtdxml @@ -7,8 +7,8 @@ system-id="boostbook.dtd" public-id="" declaration="" - created-by="DTDParse V2.0beta6" - created-on="Sat Mar 29 16:11:38 2003" + created-by="DTDParse V2.00" + created-on="Wed Feb 18 23:39:45 2009" > A global identifier for this element Set to $Date: 2003/04/13 14:46:07 $ to keep "last revised" information in sync with CVS changes @@ -23,7 +23,10 @@ type="param" > template?, inherit*, purpose?, description?, - (access|%boost.class.mix;)* + (static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + method|overloaded-method|data-member|class|class-specialization|struct| + struct-specialization|union|union-specialization|free-function-group|function|overloaded-function|access)* template?, inherit*, purpose?, description?, (access|%boost.class.mix;)* @@ -104,15 +107,18 @@ struct-specialization|union|union-specialization static-constant|typedef|enum| copy-assignment|constructor|destructor|method-group| - |method|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; +static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + 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 -|functionname|libraryname|code -|functionname|libraryname|code +|functionname|libraryname|enumname|code +|functionname|libraryname|enumname|code template?, specialization?, inherit?, purpose?, description?, - (access|%boost.class.mix;)* + (static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + method|overloaded-method|data-member|class|class-specialization|struct| + struct-specialization|union|union-specialization|free-function-group|function|overloaded-function|access)* template?, specialization?, inherit?, purpose?, description?, (access|%boost.class.mix;)* @@ -830,7 +839,7 @@ - access CDATA #REQUIRED + access CDATA #IMPLIED pack CDATA #IMPLIED %boost.common.attrib; The access specifier ("public", "private", or "protected") of the inheritance. @@ -1040,6 +1049,32 @@ default=""/> + + + + + + + + + + + + + + + %boost.common.attrib; + + + + @@ -1339,6 +1374,32 @@ + + + + + + + + + + + + + + + %boost.common.attrib; + + + + @@ -1404,11 +1465,17 @@ - %boost.common.attrib; + + alt CDATA #IMPLIED + %boost.common.attrib; + - name CDATA #REQUIRED + name CDATA #REQUIRED + specifiers CDATA #IMPLIED %boost.common.attrib; + + + + + + + + + + + + + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + @@ -1902,6 +2006,10 @@ + + + + @@ -1912,6 +2020,10 @@ + + + + Describes in one short sentence or phrase the purpose of a library @@ -2167,12 +2279,14 @@ + + A function parameter @@ -2301,59 +2415,59 @@ default=""/> - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + 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". - - - + + + name CDATA #REQUIRED + %boost.common.attrib; + + + The name of the access specification, e.g. "public", "private", or "protected". + + + @@ -2546,6 +2660,8 @@ + + A single value of an enumeration @@ -2890,6 +3006,38 @@ default=""/> + + + + + + + + + + + + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + diff --git a/doc/reference.xml b/doc/reference.xml index 2fe9a85..83a5701 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -1,7 +1,7 @@ - +
Reference - 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 + 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 enumname - Element 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 globalname - Element header - Declares a C++ header with the given nameElement headername - Element 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 macroname - Element 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 @@ -549,7 +549,7 @@ 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. +access#IMPLIEDCDATAThe access specifier ("public", "private", or "protected") of the inheritance. id#IMPLIEDCDATAA global identifier for this element pack#IMPLIEDCDATASet to '1' if this is a pack exapansion. xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -715,6 +715,40 @@ name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element macroname + 9 + + + macroname + + + macroname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +id#IMPLIEDCDATAA global identifier for this element @@ -981,6 +1015,40 @@ + + + + BoostBook element headername + 9 + + + headername + + + headername ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +id#IMPLIEDCDATAA global identifier for this element + + + + + @@ -1053,6 +1121,7 @@ last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1159,6 +1228,7 @@ 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 xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1304,6 +1374,41 @@ id#IMPLIEDCDATAA global identifier for this element pack#IMPLIEDCDATASet to '1' if this is a pack exapansion. xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element globalname + 9 + + + globalname + + + globalname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element @@ -1538,7 +1643,7 @@ Describes in one short sentence or phrase the purpose of a library librarypurpose ::= - (#PCDATA| code| ulink| functionname| methodname| classname)* + (#PCDATA| code| ulink| functionname| methodname| classname| macroname| headername| enumname| globalname)* Attributes @@ -1792,7 +1897,7 @@ A function parameter parameter ::= - (paramtype, default?) + (paramtype, default?, description?) Attributes @@ -1913,8 +2018,8 @@ 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)+ - + (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. @@ -1931,11 +2036,11 @@ - - 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 - + +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 + @@ -2422,6 +2527,41 @@ name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element enumname + 9 + + + enumname + + + enumname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element @@ -2798,4 +2938,4 @@ - +