reference.dtdxml

Boost provides free peer-reviewed portable C++ source libraries. We emphasize libraries that work

<dtd version='1.0'
     unexpanded='1'
     title="?untitled?"
     namecase-general="1"
     namecase-entity="0"
     xml="0"
     system-id="boostbook.dtd"
     public-id=""
     declaration=""
     created-by="DTDParse V2.0beta6"
     created-on="Sat Mar 29 16:11:38 2003"
>
<attpurpose name="id">A global identifier for this element</attpurpose>
<attpurpose name="last-revision">Set to $Date: 2003/04/13 14:46:07 $ to keep "last revised" information in sync with CVS changes</attpurpose>
<attpurpose name="xml:base">Implementation detail used by XIncludes</attpurpose>
<attpurpose name="name">The name of the element being declared to referenced</attpurpose>
<attpurpose name="filename">The name of the file associated with this element</attpurpose>
<attpurpose name="specifiers">The specifiers for this function, e.g., <code>inline</code>, <code>static</code>, etc.</attpurpose>
<attpurpose name="cv">cv-qualifiers for this method, e.g., <code>const volatile</code></attpurpose>
<attpurpose name="pack">Set to '1' if the parameter is a parameter pack.</attpurpose>

<entity name="boost.class.content"
        type="param"
>
<text-expanded>template?, inherit*, purpose?, description?,
              (access|%boost.class.mix;)*</text-expanded>
<text>template?, inherit*, purpose?, description?,
              (access|%boost.class.mix;)*</text>
</entity>

<entity name="boost.function.semantics"
        type="param"
>
<text-expanded>purpose?, description?, requires?, effects?, postconditions?,
         returns?, throws?, complexity?, notes?, rationale?</text-expanded>
<text>purpose?, description?, requires?, effects?, postconditions?,
         returns?, throws?, complexity?, notes?, rationale?</text>
</entity>

<entity name="parameter.module"
        type="param"
>
<text-expanded>IGNORE</text-expanded>
<text>IGNORE</text>
</entity>

<entity name="local.classname.attrib"
        type="param"
>
<text-expanded>alt CDATA #IMPLIED</text-expanded>
<text>alt CDATA #IMPLIED</text>
</entity>

<entity name="boost.namespace.mix"
        type="param"
>
<text-expanded>class|class-specialization|struct|struct-specialization|
         union|union-specialization|typedef|enum|
         free-function-group|function|overloaded-function|
         namespace</text-expanded>
<text>class|class-specialization|struct|struct-specialization|
         union|union-specialization|typedef|enum|
         free-function-group|function|overloaded-function|
         namespace</text>
</entity>

<entity name="boost.testsuite.test.content"
        type="param"
>
<text-expanded>source*, lib*, requirement*, purpose, if-fails?</text-expanded>
<text>source*, lib*, requirement*, purpose, if-fails?</text>
</entity>

<entity name="programlisting.module"
        type="param"
>
<text-expanded>IGNORE</text-expanded>
<text>IGNORE</text>
</entity>

<entity name="local.refentry.class"
        type="param"
>
<text-expanded>|library-reference|testsuite</text-expanded>
<text>|library-reference|testsuite</text>
</entity>

<entity name="boost.common.attrib"
        type="param"
>
<text-expanded>xml:base      CDATA  #IMPLIED
                                last-revision CDATA  #IMPLIED
                                id            CDATA  #IMPLIED</text-expanded>
<text>%local.common.attrib;
                                id            CDATA  #IMPLIED</text>
</entity>

<entity name="boost.class.members"
        type="param"
>
<text-expanded>static-constant|typedef|enum|
         copy-assignment|constructor|destructor|method-group|
         method|overloaded-method|data-member|class|class-specialization|struct|
         struct-specialization|union|union-specialization</text-expanded>
<text>static-constant|typedef|enum|
         copy-assignment|constructor|destructor|method-group|
         |method|overloaded-method|data-member|class|class-specialization|struct|
         struct-specialization|union|union-specialization</text>
</entity>

<entity name="boost.class.mix"
        type="param"
>
<text-expanded>free-function-group|function|overloaded-function|%boost.class.members;</text-expanded>
<text>free-function-group|function|overloaded-function|%boost.class.members;</text>
</entity>

<entity name="boost.testsuite.tests"
        type="param"
>
<text-expanded>compile-test|link-test|run-test|
         compile-fail-test|link-fail-test|run-fail-test</text-expanded>
<text>compile-test|link-test|run-test|
         compile-fail-test|link-fail-test|run-fail-test</text>
</entity>

<entity name="local.para.class"
        type="param"
>
<text-expanded>|using-namespace|using-class|librarylist|librarycategorylist</text-expanded>
<text>|using-namespace|using-class|librarylist|librarycategorylist</text>
</entity>

<entity name="DocBook"
        type="param"
        public="-//OASIS//DTD DocBook XML V4.2//EN"
        system="http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
/>

<entity name="local.title.char.mix"
        type="param"
>
<text-expanded></text-expanded>
<text></text>
</entity>

<entity name="local.methodname.attrib"
        type="param"
>
<text-expanded>alt CDATA #IMPLIED</text-expanded>
<text>alt CDATA #IMPLIED</text>
</entity>

<entity name="local.tech.char.class"
        type="param"
>
<text-expanded>|functionname|libraryname|code</text-expanded>
<text>|functionname|libraryname|code</text>
</entity>

<entity name="function.module"
        type="param"
>
<text-expanded>IGNORE</text-expanded>
<text>IGNORE</text>
</entity>

<entity name="boost.template.mix"
        type="param"
>
<text-expanded>template-type-parameter|template-nontype-parameter|template-varargs</text-expanded>
<text>template-type-parameter|template-nontype-parameter|template-varargs</text>
</entity>

<entity name="local.common.attrib"
        type="param"
>
<text-expanded>xml:base      CDATA  #IMPLIED
                                last-revision CDATA  #IMPLIED</text-expanded>
<text>xml:base      CDATA  #IMPLIED
                                last-revision CDATA  #IMPLIED</text>
</entity>

<entity name="type.module"
        type="param"
>
<text-expanded>IGNORE</text-expanded>
<text>IGNORE</text>
</entity>

<entity name="local.descobj.class"
        type="param"
>
<text-expanded>|libraryinfo</text-expanded>
<text>|libraryinfo</text>
</entity>

<entity name="boost.class-specialization.content"
        type="param"
>
<text-expanded>template?, specialization?, inherit?, purpose?, description?,
              (access|%boost.class.mix;)*</text-expanded>
<text>template?, specialization?, inherit?, purpose?, description?,
              (access|%boost.class.mix;)*</text>
</entity>

<entity name="library.content"
        type="param"
>
<text-expanded>libraryinfo, (title, ((section|library-reference|testsuite))+)?</text-expanded>
<text>libraryinfo, (title, ((section|library-reference|testsuite))+)?</text>
</entity>

<element name="class-specialization"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="template" occurrence="?"/>
    <element-name name="specialization" occurrence="?"/>
    <element-name name="inherit" occurrence="?"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
    <or-group occurrence="*">
      <element-name name="access"/>
      <element-name name="static-constant"/>
      <element-name name="typedef"/>
      <element-name name="enum"/>
      <element-name name="copy-assignment"/>
      <element-name name="constructor"/>
      <element-name name="destructor"/>
      <element-name name="method-group"/>
      <element-name name="free-function-group"/>
      <element-name name="function"/>
      <element-name name="method"/>
      <element-name name="overloaded-function"/>
      <element-name name="overloaded-method"/>
      <element-name name="data-member"/>
      <element-name name="class"/>
      <element-name name="class-specialization"/>
      <element-name name="struct"/>
      <element-name name="struct-specialization"/>
      <element-name name="union"/>
      <element-name name="union-specialization"/>
    </or-group>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <parament-name name="boost.class-specialization.content"/>
  </sequence-group>
</content-model>

<purpose>A specialization (partial or full) of a class template</purpose>
</element>

<attlist name="class-specialization">
<attdecl>
    name  CDATA  #REQUIRED
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="name"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
<attribute name="id"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="xml:base"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="link-test"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="source" occurrence="*"/>
    <element-name name="lib" occurrence="*"/>
    <element-name name="requirement" occurrence="*"/>
    <element-name name="purpose"/>
    <element-name name="if-fails" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <parament-name name="boost.testsuite.test.content"/>
  </sequence-group>
</content-model>
<purpose>Declares a test that should compile and link</purpose>
</element>

<attlist name="link-test">
<attdecl>
     filename CDATA #REQUIRED
     name     CDATA #IMPLIED</attdecl>
<attribute name="filename"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
<attribute name="name"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="link-fail-test"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="source" occurrence="*"/>
    <element-name name="lib" occurrence="*"/>
    <element-name name="requirement" occurrence="*"/>
    <element-name name="purpose"/>
    <element-name name="if-fails" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <parament-name name="boost.testsuite.test.content"/>
  </sequence-group>
</content-model>
<purpose>Declares a test that should compile but fail to link</purpose>
</element>

<attlist name="link-fail-test">
<attdecl>
     filename CDATA #REQUIRED
     name     CDATA #IMPLIED</attdecl>
<attribute name="filename"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
<attribute name="name"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="typedef"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
  </sequence-group>
</content-model>
<purpose>Declares a typedef</purpose>
</element>

<attlist name="typedef">
<attdecl>
    name     CDATA  #REQUIRED
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="name"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
<attribute name="id"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="xml:base"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="static-constant"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="default"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="default"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
  </sequence-group>
</content-model>
<purpose>Declares a static constant, e.g., <code>const int foo = 5;</code>.</purpose>
</element>

<attlist name="static-constant">
<attdecl>
    name   CDATA  #REQUIRED
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="name"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
<attribute name="id"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="xml:base"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="code"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>Mimics the <sgmltag>code</sgmltag> tag in HTML</purpose>
<description>
  <para>Text within a <sgmltag>code</sgmltag> tag is generally typeset
  in a different, monospaced font so that it stands out as code. The
  <sgmltag>code</sgmltag> tag in BoostBook is transformed directly
  into the <sgmltag>computeroutput</sgmltag> tag in DocBook.</para>
</description>
</element>

<attlist name="code">
<attdecl> %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"