reference.dtdxml

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

           default=""/>
<attribute name="id"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="xml:base"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
</attlist>

<element name="destructor"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <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>
    <parament-name name="boost.function.semantics"/>
  </sequence-group>
</content-model>
<purpose>Declares a destructor for the enclosing class</purpose>
<description>
  <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="destructor">
<attdecl>
    specifiers   CDATA  #IMPLIED
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           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="template-type-parameter"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="default" occurrence="?"/>
    <element-name name="purpose" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="default" occurrence="?"/>
    <element-name name="purpose" occurrence="?"/>
  </sequence-group>
</content-model>
<purpose>Declares a template type parameter</purpose>
</element>

<attlist name="template-type-parameter">
<attdecl>
    name                     CDATA  #REQUIRED
    pack                     CDATA  #IMPLIED 
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="pack"
           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="description"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <any/>
  </sequence-group>
</content-model>
<purpose>Detailed description of a construct</purpose>
<description>
  <para>Although the context model for this element is
  <code>ANY</code>, detailed descriptions should contain structured
  DocBook elements that occur within sections, e.g., paragraphs
  (<sgmltag>para</sgmltag>, <sgmltag>simpara</sgmltag>), lists
  (<sgmltag>orderedlist</sgmltag>, <sgmltag>itemizedlist</sgmltag>),
  tables (<sgmltag>informaltable</sgmltag>, <sgmltag>table</sgmltag>),
  etc.</para>
</description>
</element>

<attlist name="description">
<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="librarylist"
         content-type="element">
<content-model-expanded>
  <empty/>
</content-model-expanded>
<content-model>
  <empty/>
</content-model>
<purpose>Placeholder for an alphabetical list of libraries</purpose>
<description>
  <para>Developers aren't generally expected to use this element. Its existence is mainly as a placeholder in <filename>boost.xml</filename> for the alphabetical list of libraries.</para>
</description>
</element>

<attlist name="librarylist">
<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="library-reference"
         content-type="element">
<!-- DPG brazenly modified the content model here, because "ANY" is
     not a good idea and merging this document with another is, to say the
     least, a PITA. -->
<content-model-expanded>
  <sequence-group>
    <element-name name="title" occurrence="?"/>
    <element-name name="section" occurrence="*"/>
    <or-group occurrence="*">
      <element-name name="header"/>
      <element-name name="library-reference"/>
    </or-group>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="title" occurrence="?"/>
    <element-name name="section" occurrence="*"/>
    <or-group>
      <element-name name="header" occurrence="*"/>
      <element-name name="library-reference" occurrence="*"/>
    </or-group>
  </sequence-group>
</content-model>
<purpose>Declares the reference material for a library</purpose>
<description>
  <para>Reference documentation for a library is contained with a
  &lt;library-reference&gt; element. The &lt;library-reference&gt;
  element has no attributes, and contains as children only
  &lt;header&gt; elements.</para>

  <para>The &lt;header&gt; element defines a C++ header file. Within
  each C++ header file lie the definitions of C++ constructs to be
  documented. The <code>name</code> attribute of the &lt;header&gt;
  element gives the name of the header, as one would specify when
  including the header. For instance, the &lt;library-reference&gt;
  for the <libraryname>Any</libraryname> library may look like
  this:</para>

  <programlisting>&lt;library-reference&gt;
  &lt;header name="boost/any.hpp"&gt;
    &lt;!-- C++ constructs in this header --&gt;
  &lt;/header&gt;
&lt;/library-reference&gt;</programlisting>

  <para>If the <libraryname>Any</libraryname> library contained
  multiple headers, we would list them all as children of the
  &lt;library-reference&gt; element.</para>

  <para><sgmltag>library-reference</sgmltag> elements can be nested,
  so that reference material can be divided into separate sections
  that each contain different headers.</para>
</description>
</element>

<attlist name="library-reference">
<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="boostbook"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="title"/>
    <or-group occurrence="*">
      <element-name name="chapter"/>
      <element-name name="library"/>
    </or-group>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="title"/>
    <or-group occurrence="*">
      <element-name name="chapter"/>
      <element-name name="library"/>
    </or-group>
  </sequence-group>
</content-model>
<purpose>Defines a BoostBook book</purpose>
<description>
  <simpara>This element is the topmost level defined by
  <filename>boost.xml</filename> for all Boost documentation. It will
  not generally be used by developers.</simpara>
</description>
</element>

<attlist name="boostbook">
<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"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="template" 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.content"/>
  </sequence-group>
</content-model>
<purpose>Declares a C++ union or union template</purpose>
</element>

<attlist name="union">
<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="inherit"
         content-type="element">
<content-model-expanded>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="purpose" occurrence="?"/>
  </sequence-group>
</content-model-expanded>
<content-model>
  <sequence-group>
    <element-name name="type"/>
    <element-name name="purpose" occurrence="?"/>
  </sequence-group>
</content-model>
<purpose>Declares a base class of the enclosing class or struct</purpose>

<description>
  <para>This element contains the type of the class inherited.</para>
</description>
</element>

<attlist name="inherit">
<attdecl>
    access  CDATA  #REQUIRED
    pack    CDATA  #IMPLIED 
    %boost.common.attrib;</attdecl>
<attribute name="last-revision"
           type="#IMPLIED"
           value="CDATA"
           default=""/>
<attribute name="access"
           type="#REQUIRED"
           value="CDATA"
           default="">
  <purpose>The access specifier ("public", "private", or "protected") of the inheritance.</purpose>
</attribute>
<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="template-varargs"
         content-type="element">
<content-model-expanded>
  <empty/>
</content-model-expanded>
<content-model>
  <empty/>
</content-model>
<purpose>Declares a variable-length list of template parameters</purpose>

<description>
  <para>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
  can be used anywhere any other template parameter can be
  used.</para>
</description>
</element>

<attlist name="template-varargs">
<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="source"
         content-type="mixed">
<content-model-expanded>
  <or-group occurrence="*">
    <pcdata/>
    <element-name name="snippet"/>
  </or-group>
</content-model-expanded>
<content-model>
  <or-group occurrence="*">