reference.dtdxml

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

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

<element name="using-class"
         content-type="element">
<content-model-expanded>
  <empty/>
</content-model-expanded>
<content-model>
  <empty/>
</content-model>
<purpose>Injects the method and function names of a class into the local scope</purpose>
</element>

<attlist name="using-class">
<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="run-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>A testcase that should compile, link, and execute</purpose>
</element>

<attlist name="run-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="librarypurpose"
         content-type="mixed">
<content-model-expanded>
  <or-group occurrence="*">
    <pcdata/>
    <element-name name="code"/>
    <element-name name="ulink"/>
    <element-name name="functionname"/>
    <element-name name="methodname"/>
    <element-name name="classname"/>
  </or-group>
</content-model-expanded>
<content-model>
  <or-group occurrence="*">
    <pcdata/>
    <element-name name="code"/>
    <element-name name="ulink"/>
    <element-name name="functionname"/>
    <element-name name="methodname"/>
    <element-name name="classname"/>
  </or-group>
</content-model>
<purpose>Describes in one short sentence or phrase the purpose of a library</purpose>
</element>

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

<element name="copy-assignment"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="template" occurrence="?"/>
    <element-name name="type" occurrence="?"/>
    <element-name name="parameter" occurrence="*"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
    <element-name name="requires" occurrence="?"/>
    <element-name name="effects" occurrence="?"/>
    <element-name name="postconditions" occurrence="?"/>
    <element-name name="returns" occurrence="?"/>
    <element-name name="throws" occurrence="?"/>
    <element-name name="complexity" occurrence="?"/>
    <element-name name="notes" occurrence="?"/>
    <element-name name="rationale" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="template" occurrence="?"/>
    <element-name name="type" occurrence="?"/>
    <element-name name="parameter" occurrence="*"/>
    <parament-name name="boost.function.semantics"/>
  </sequence-group>
</content-model>
<purpose>Declares a copy-assignment operator</purpose>
<description>
  <para>The return type of the copy-assignment operator does not need
  to be specified. If left unspecified, it will default to an
  unqualified reference to the enclosing class type.</para>

  <para>General documentation on functions in BoostBook is provided in
  the <link
  linkend="boostbook.dtd.function"><sgmltag>function</sgmltag></link>
  element documentation.</para>
</description>
</element>

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

<element name="run-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>A testcase that should compile and link, but fail on execution</purpose>
</element>

<attlist name="run-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="template"
         content-type="element">
<content-model-expanded>
  <or-group occurrence="*">
    <element-name name="template-type-parameter"/>
    <element-name name="template-nontype-parameter"/>
    <element-name name="template-varargs"/>
  </or-group>
</content-model-expanded>
<content-model>
  <sequence-group occurrence="*">
    <parament-name name="boost.template.mix"/>
  </sequence-group>
</content-model>
<purpose>Declares the template parameters of a class or function</purpose>
</element>

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

<element name="compile-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>A testcase that should fail to compile</purpose>
</element>

<attlist name="compile-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="returns"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>Description of the return value of a function</purpose>
</element>

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

<element name="default"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>The default value of a function or template parameter</purpose>
</element>

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

<element name="parameter"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="paramtype"/>
    <element-name name="default" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="paramtype"/>
    <element-name name="default" occurrence="?"/>
  </sequence-group>
</content-model>
<purpose>A function parameter</purpose>
</element>

<attlist name="parameter">
<attdecl>
     name CDATA #IMPLIED
     pack CDATA #IMPLIED</attdecl>
<attribute name="name"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="pack"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="signature"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="template" occurrence="?"/>
    <element-name name="type"/>
    <element-name name="parameter" occurrence="*"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="template" occurrence="?"/>
    <element-name name="type"/>
    <element-name name="parameter" occurrence="*"/>
  </sequence-group>
</content-model>
<purpose>One signature of an overloaded function or method</purpose>
<description>
  <para>
    A signature refers to one declaration of an overloaded function or
    method. The signature itself has no name, because the name of the
    overloaded function or method is used. An overloaded function or
    method will have several signatures that will generally be typeset
    together.
  </para>
</description>
</element>

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

<element name="overloaded-function"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="signature" occurrence="*"/>
    <element-name name="purpose" occurrence="?"/>
    <element-name name="description" occurrence="?"/>
    <element-name name="requires" occurrence="?"/>
    <element-name name="effects" occurrence="?"/>
    <element-name name="postconditions" occurrence="?"/>
    <element-name name="returns" occurrence="?"/>
    <element-name name="throws" occurrence="?"/>
    <element-name name="complexity" occurrence="?"/>
    <element-