reference.dtdxml

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

<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="functionname"
         content-type="mixed">
<content-model-expanded>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model>
<purpose>References a function with the given name</purpose>
<description>
  <para>If a function (or overloaded function) with the given,
  possibly-qualified name is found, this generates a link to that
  function. Lookups obey currently-active <link
  linkend="boostbook.dtd.using-class"><sgmltag>using-class</sgmltag></link>
  and <link
  linkend="boostbook.dtd.using-namespace"><sgmltag>using-namespace</sgmltag></link>
  directives to aid in the search, along with searching within the
  current scope.</para>
</description>
</element>

<attlist name="functionname">
<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="librarycategory"
         content-type="mixed">
<content-model-expanded>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model>
<purpose>Declares that the enclosing library is in this category</purpose>
</element>

<attlist name="librarycategory">
<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="notes"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>Non-normative notes about a function's semantics</purpose>
</element>

<attlist name="notes">
<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="data-member"
         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 data member of a class</purpose>
</element>

<attlist name="data-member">
<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="specialization"
         content-type="element">
<content-model-expanded>
  <sequence-group occurrence="*">
    <element-name name="template-arg"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group occurrence="*">
    <element-name name="template-arg"/>
  </sequence-group>
</content-model>
<purpose>Defines the specialization arguments for a class specialization</purpose>
</element>

<attlist name="specialization">
<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="union-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 (full or partial) of a union template</purpose>
</element>

<attlist name="union-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="throws"
         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 exceptions thrown by a function</purpose>
</element>

<attlist name="throws">
<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="template-arg"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>A template argument in a specialization</purpose>
</element>

<attlist name="template-arg">
<attdecl>
    pack    CDATA  #IMPLIED 
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="id"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="pack"
           type="#IMPLIED"
           value="CDATA"
           default="">
  <purpose>Set to '1' if this is a pack exapansion.</purpose>
</attribute>
<attribute name="xml:base"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="method-group"
         content-type="element">
<content-model-expanded>
  <or-group occurrence="*">
    <element-name name="method"/>
    <element-name name="overloaded-method"/>
  </or-group>
</content-model-expanded>
<content-model>
  <or-group occurrence="*">
    <element-name name="method"/>
    <element-name name="overloaded-method"/>
  </or-group>
</content-model>
<purpose>A set of methods that are grouped together under one name</purpose>
</element>

<attlist name="method-group">
<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="requirement"
         content-type="mixed">
<content-model-expanded>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <pcdata/>
  </sequence-group>
</content-model>
<purpose>A requirement/property in the Jamfile for a testcase</purpose>
<description>
  <para>A requirement is part of the dependencies of a target in a
  Jamfile. The <code>name</code> attribute of a requirement element
  gives the name of the Boost.Build feature and the content of the
  requirement gives the value of that feature. A requirement such as
  <code>&lt;includes&gt;foo.hpp</code> would be encoded as
  <code>&lt;requirement
  name="includes"&gt;foo.hpp&lt;/requirement&gt;</code>.</para>
</description>
</element>

<attlist name="requirement">
<attdecl>
     name CDATA #REQUIRED</attdecl>
<attribute name="name"
           type="#REQUIRED"
           value="CDATA"
           default=""/>
</attlist>

<element name="precondition"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>Conditions that must be met prior to executing a function</purpose>
</element>

<attlist name="precondition">
<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="paramtype"
         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 type of a function parameter</purpose>
</element>