--- /dev/null
+index.html
+docbook/api/class-specialization.html
+docbook/api/link-test.html
+docbook/api/link-fail-test.html
+docbook/api/typedef.html
+docbook/api/static-constant.html
+docbook/api/code.html
+docbook/api/destructor.html
+docbook/api/template-type-parameter.html
+docbook/api/description.html
+docbook/api/librarylist.html
+docbook/api/library-reference.html
+docbook/api/api.html
+docbook/api/union.html
+docbook/api/inherit.html
+docbook/api/template-varargs.html
+docbook/api/source.html
+docbook/api/function.html
+docbook/api/macroname.html
+docbook/api/postconditions.html
+docbook/api/compile-test.html
+docbook/api/method.html
+docbook/api/snippet.html
+docbook/api/constructor.html
+docbook/api/namespace.html
+docbook/api/if-fails.html
+docbook/api/headername.html
+docbook/api/free-function-group.html
+docbook/api/functionname.html
+docbook/api/librarycategory.html
+docbook/api/notes.html
+docbook/api/data-member.html
+docbook/api/specialization.html
+docbook/api/union-specialization.html
+docbook/api/throws.html
+docbook/api/template-arg.html
+docbook/api/globalname.html
+docbook/api/method-group.html
+docbook/api/requirement.html
+docbook/api/precondition.html
+docbook/api/paramtype.html
+docbook/api/using-class.html
+docbook/api/run-test.html
+docbook/api/librarypurpose.html
+docbook/api/copy-assignment.html
+docbook/api/run-fail-test.html
+docbook/api/template.html
+docbook/api/compile-fail-test.html
+docbook/api/returns.html
+docbook/api/default.html
+docbook/api/parameter.html
+docbook/api/signature.html
+docbook/api/overloaded-function.html
+docbook/api/access.html
+docbook/api/class.html
+docbook/api/librarycategorydef.html
+docbook/api/type.html
+docbook/api/enumvalue.html
+docbook/api/overloaded-method.html
+docbook/api/programlisting.html
+docbook/api/complexity.html
+docbook/api/purpose.html
+docbook/api/template-nontype-parameter.html
+docbook/api/library.html
+docbook/api/librarycategorylist.html
+docbook/api/using-namespace.html
+docbook/api/enumname.html
+docbook/api/struct-specialization.html
+docbook/api/struct.html
+docbook/api/lib.html
+docbook/api/enum.html
+docbook/api/requires.html
+docbook/api/effects.html
+docbook/api/libraryname.html
+docbook/api/libraryinfo.html
+docbook/api/testsuite.html
+docbook/api/header.html
+docbook/api/rationale.html
--- /dev/null
+/*=============================================================================
+ Copyright (c) 2004 Joel de Guzman
+ http://spirit.sourceforge.net/
+
+ Distributed under the Boost Software License, Version 1.0. (See accompany-
+ ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================*/
+
+/*=============================================================================
+ Body defaults
+=============================================================================*/
+
+ body
+ {
+ margin: 1em;
+ font-family: sans-serif;
+ }
+
+/*=============================================================================
+ Paragraphs
+=============================================================================*/
+
+ p
+ {
+ text-align: left;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+/*=============================================================================
+ Program listings
+=============================================================================*/
+
+ /* Code on paragraphs */
+ p tt.computeroutput
+ {
+ font-size: 9pt;
+ }
+
+ pre.synopsis
+ {
+ font-size: 9pt;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ .programlisting,
+ .screen
+ {
+ font-size: 9pt;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ /* Program listings in tables don't get borders */
+ td .programlisting,
+ td .screen
+ {
+ margin: 0pc 0pc 0pc 0pc;
+ padding: 0pc 0pc 0pc 0pc;
+ }
+
+/*=============================================================================
+ Headings
+=============================================================================*/
+
+ h1, h2, h3, h4, h5, h6
+ {
+ text-align: left;
+ margin: 1em 0em 0.5em 0em;
+ font-weight: bold;
+ }
+
+ h1 { font: 140% }
+ h2 { font: bold 140% }
+ h3 { font: bold 130% }
+ h4 { font: bold 120% }
+ h5 { font: italic 110% }
+ h6 { font: italic 100% }
+
+ /* Top page titles */
+ title,
+ h1.title,
+ h2.title
+ h3.title,
+ h4.title,
+ h5.title,
+ h6.title,
+ .refentrytitle
+ {
+ font-weight: bold;
+ margin-bottom: 1pc;
+ }
+
+ h1.title { font-size: 140% }
+ h2.title { font-size: 140% }
+ h3.title { font-size: 130% }
+ h4.title { font-size: 120% }
+ h5.title { font-size: 110% }
+ h6.title { font-size: 100% }
+
+ .section h1
+ {
+ margin: 0em 0em 0.5em 0em;
+ font-size: 140%;
+ }
+
+ .section h2 { font-size: 140% }
+ .section h3 { font-size: 130% }
+ .section h4 { font-size: 120% }
+ .section h5 { font-size: 110% }
+ .section h6 { font-size: 100% }
+
+ /* Code on titles */
+ h1 tt.computeroutput { font-size: 140% }
+ h2 tt.computeroutput { font-size: 140% }
+ h3 tt.computeroutput { font-size: 130% }
+ h4 tt.computeroutput { font-size: 130% }
+ h5 tt.computeroutput { font-size: 130% }
+ h6 tt.computeroutput { font-size: 130% }
+
+
+/*=============================================================================
+ Author
+=============================================================================*/
+
+ h3.author
+ {
+ font-size: 100%
+ }
+
+/*=============================================================================
+ Lists
+=============================================================================*/
+
+ li
+ {
+ font-size: 10pt;
+ line-height: 1.3;
+ }
+
+ /* Unordered lists */
+ ul
+ {
+ text-align: left;
+ }
+
+ /* Ordered lists */
+ ol
+ {
+ text-align: left;
+ }
+
+/*=============================================================================
+ Links
+=============================================================================*/
+
+ a
+ {
+ text-decoration: none; /* no underline */
+ }
+
+ a:hover
+ {
+ text-decoration: underline;
+ }
+
+/*=============================================================================
+ Spirit style navigation
+=============================================================================*/
+
+ .spirit-nav
+ {
+ text-align: right;
+ }
+
+ .spirit-nav a
+ {
+ color: white;
+ padding-left: 0.5em;
+ }
+
+ .spirit-nav img
+ {
+ border-width: 0px;
+ }
+
+/*=============================================================================
+ Copyright footer
+=============================================================================*/
+ .copyright-footer
+ {
+ text-align: right;
+ font-size: 70%;
+ }
+
+ .copyright-footer p
+ {
+ text-align: right;
+ font-size: 80%;
+ }
+
+/*=============================================================================
+ Table of contents
+=============================================================================*/
+
+ .toc
+ {
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.1pc 1pc 0.1pc 1pc;
+ font-size: 80%;
+ line-height: 1.15;
+ }
+
+ .api-toc
+ {
+ float: right;
+ padding: 0.5pc;
+ }
+
+ /* Code on toc */
+ .toc .computeroutput { font-size: 120% }
+
+/*=============================================================================
+ Tables
+=============================================================================*/
+
+ .table-title,
+ div.table p.title
+ {
+ margin-left: 4%;
+ padding-right: 0.5em;
+ padding-left: 0.5em;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ width: 92%;
+ margin-left: 4%;
+ margin-right: 4%;
+ }
+
+ div.informaltable table,
+ div.table table
+ {
+ padding: 4px;
+ }
+
+ /* Table Cells */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ padding: 0.5em;
+ text-align: left;
+ font-size: 9pt;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ border: 1pt solid white;
+ font-size: 80%;
+ }
+
+ table.simplelist
+ {
+ width: auto !important;
+ margin: 0em !important;
+ padding: 0em !important;
+ border: none !important;
+ }
+ table.simplelist td
+ {
+ margin: 0em !important;
+ padding: 0em !important;
+ text-align: left !important;
+ font-size: 9pt !important;
+ border: none !important;
+ }
+
+/*=============================================================================
+ Blurbs
+=============================================================================*/
+
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ font-size: 9pt; /* A little bit smaller than the main text */
+ line-height: 1.2;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ p.blurb img
+ {
+ padding: 1pt;
+ }
+
+/*=============================================================================
+ Variable Lists
+=============================================================================*/
+
+ div.variablelist
+ {
+ margin: 1em 0;
+ }
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt,
+ span.term
+ {
+ font-weight: bold;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td
+ {
+ text-align: left;
+ vertical-align: top;
+ padding: 0em 2em 0em 0em;
+ font-size: 10pt;
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+ div.variablelist dl dt
+ {
+ margin-bottom: 0.2em;
+ }
+
+ div.variablelist dl dd
+ {
+ margin: 0em 0em 0.5em 2em;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td p,
+ div.variablelist dl dd p
+ {
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+/*=============================================================================
+ Misc
+=============================================================================*/
+
+ /* Title of books and articles in bibliographies */
+ span.title
+ {
+ font-style: italic;
+ }
+
+ span.underline
+ {
+ text-decoration: underline;
+ }
+
+ span.strikethrough
+ {
+ text-decoration: line-through;
+ }
+
+ /* Copyright, Legal Notice */
+ div div.legalnotice p
+ {
+ text-align: left
+ }
+
+/*=============================================================================
+ Colors
+=============================================================================*/
+
+ @media screen
+ {
+ body {
+ background-color: #FFFFFF;
+ color: #000000;
+ }
+
+ /* Syntax Highlighting */
+ .keyword { color: #0000AA; }
+ .identifier { color: #000000; }
+ .special { color: #707070; }
+ .preprocessor { color: #402080; }
+ .char { color: teal; }
+ .comment { color: #800000; }
+ .string { color: teal; }
+ .number { color: teal; }
+ .white_bkd { background-color: #FFFFFF; }
+ .dk_grey_bkd { background-color: #999999; }
+
+ /* Links */
+ a, a .keyword, a .identifier, a .special, a .preprocessor
+ a .char, a .comment, a .string, a .number
+ {
+ color: #005a9c;
+ }
+
+ a:visited, a:visited .keyword, a:visited .identifier,
+ a:visited .special, a:visited .preprocessor a:visited .char,
+ a:visited .comment, a:visited .string, a:visited .number
+ {
+ color: #9c5a9c;
+ }
+
+ h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
+ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
+ h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
+ {
+ text-decoration: none; /* no underline */
+ color: #000000;
+ }
+
+ /* Copyright, Legal Notice */
+ .copyright
+ {
+ color: #666666;
+ font-size: small;
+ }
+
+ div div.legalnotice p
+ {
+ color: #666666;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Blurbs */
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ background-color: #F0F0F0;
+ border: 1px solid #DCDCDC;
+ }
+
+ .copyright-footer
+ {
+ color: #8F8F8F;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ color: #00A000;
+ }
+ }
+
+ @media print
+ {
+ /* Links */
+ a
+ {
+ color: black;
+ }
+
+ a:visited
+ {
+ color: black;
+ }
+
+ .spirit-nav
+ {
+ display: none;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid gray;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid gray;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid gray;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ border: 1px solid gray;
+ border-collapse: collapse;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid gray;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ border: 1px solid gray;
+ }
+
+ table.simplelist tr td
+ {
+ border: none !important;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ font-weight: bold;
+ }
+ }
+
+/*=============================================================================
+ Images
+=============================================================================*/
+
+ span.inlinemediaobject img
+ {
+ vertical-align: middle;
+ }
+
+/*==============================================================================
+ Super and Subscript: style so that line spacing isn't effected, see
+ http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341
+==============================================================================*/
+
+sup,
+sub {
+ height: 0;
+ line-height: 1;
+ vertical-align: baseline;
+ _vertical-align: bottom;
+ position: relative;
+
+}
+
+sup {
+ bottom: 1ex;
+}
+
+sub {
+ top: .5ex;
+}
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element access</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.access"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">access</code></span></h2>
+<p>
+ access
+ — Declares an access specification for class members
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>access ::=
+ (<a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)+
+</div>
+ <div class="refsection">
+<a name="id1951496"></a><h2>Description</h2>
+ <p>The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element.</p>
+ </div>
+ <div class="refsection">
+<a name="id1951494"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the access specification, e.g. "public", "private", or "protected".</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element api</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.api"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">api</code></span></h2>
+<p>
+ api
+ — Defines an API
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>api ::=
+ (title, (chapter| <a class="link" href="library.html" title="DocBook API Element library">library</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1945153"></a><h2>Description</h2>
+ <p>This element is the topmost level defined by
+ main XML file for all API documentation</p>
+</div>
+ <div class="refsection">
+<a name="id1945155"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element class-specialization</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.class-specialization"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">class-specialization</code></span></h2>
+<p>
+ class-specialization
+ — A specialization (partial or full) of a class template
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>class-specialization ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="specialization.html" title="DocBook API Element specialization">specialization</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1943263"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element class</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.class"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">class</code></span></h2>
+<p>
+ class
+ — Declares a class or class template
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>class ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1951734"></a><h2>Description</h2>
+ <p>C++ classes and class templates are described via the
+ <class> element. Each class has a name (e.g., "any") given by
+ the <code class="code">name</code> attribute, a purpose given by the
+ <purpose> element, documentation, and a set of types,
+ functions, base classes, and data members. Here is a minimal
+ definition of the <code class="classname">boost::any</code> class:</p>
+
+ <pre class="programlisting"><namespace name="boost">
+ <class name="any">
+ <purpose>
+ A class whose instances can hold instances of any type that satisfies
+ ValueType requirements.
+ </purpose>
+ </class>
+</namespace></pre>
+
+ <p>Additional class documentation can be contained in a
+ <code class="sgmltag-element">description</code> element following the <purpose>
+ element. This documentation will be typeset prior to documentation
+ for specific elements in the class (e.g., constructors or
+ methods).</p>
+
+ <p>Class inheritance is described via the <inherit>
+ element. The <inherit> element requires an <code class="code">access</code>
+ attribute which must be one of <span class="emphasis"><em>public</em></span>,
+ <span class="emphasis"><em>protected</em></span>, or <span class="emphasis"><em>private</em></span>. The
+ content of the <inherited> element in C++ code that names the
+ class inherited, and may contain markup to link to the class. The
+ following description of the class
+ <code class="classname">boost::bad_any_cast</code> describes public
+ inheritance from the class <code class="classname">std::bad_cast</code>. It
+ also defines the <purpose> element, which contains a short
+ description of the use of the class.</p>
+
+ <pre class="programlisting"><class name="bad_any_cast">
+ <inherit access="public"><classname>std::bad_cast</classname></inherit>
+ <purpose><para>The exception thrown in the event of a failed
+ <functionname>any_cast</functionname> of an
+ <classname>any</classname> value.</para></purpose>
+</class></pre>
+
+ <p>Class templates are defined by <class> elements with a
+ <template> child element at the beginning.</p>
+</div>
+ <div class="refsection">
+<a name="id1951971"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element code</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.code"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">code</code></span></h2>
+<p>
+ code
+ — Mimics the <code class="sgmltag-element">code</code> tag in HTML
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>code ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1944139"></a><h2>Description</h2>
+ <p>Text within a <code class="sgmltag-element">code</code> tag is generally typeset
+ in a different, monospaced font so that it stands out as code. The
+ <code class="sgmltag-element">code</code> tag in api is transformed directly
+ into the <code class="sgmltag-element">computeroutput</code> tag in DocBook.</p>
+</div>
+ <div class="refsection">
+<a name="id1944167"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element compile-fail-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.compile-fail-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">compile-fail-test</code></span></h2>
+<p>
+ compile-fail-test
+ — A testcase that should fail to compile
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>compile-fail-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1950612"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element compile-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.compile-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">compile-test</code></span></h2>
+<p>
+ compile-test
+ — A testcase that should compile correctly
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>compile-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1946496"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element complexity</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.complexity"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">complexity</code></span></h2>
+<p>
+ complexity
+ — The time/space/etc. complexity of a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>complexity ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1952841"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element constructor</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.constructor"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">constructor</code></span></h2>
+<p>
+ constructor
+ — Declares a constructor of the enclosing class
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>constructor ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="parameter.html" title="DocBook API Element parameter">parameter</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1946964"></a><h2>Description</h2>
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1947038"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element copy-assignment</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.copy-assignment"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">copy-assignment</code></span></h2>
+<p>
+ copy-assignment
+ — Declares a copy-assignment operator
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>copy-assignment ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="type.html" title="DocBook API Element type">type</a>?, <a class="link" href="parameter.html" title="DocBook API Element parameter">parameter</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1950055"></a><h2>Description</h2>
+ <p>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.</p>
+
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1950056"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>cv</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>cv-qualifiers for this method, e.g., const volatile</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element data-member</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.data-member"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">data-member</code></span></h2>
+<p>
+ data-member
+ — Declares a data member of a class
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>data-member ::=
+ (<a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1948186"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element default</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.default"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">default</code></span></h2>
+<p>
+ default
+ — The default value of a function or template parameter
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>default ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1950845"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element description</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.description"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">description</code></span></h2>
+<p>
+ description
+ — Detailed description of a construct
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>description ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1944661"></a><h2>Description</h2>
+ <p>Although the context model for this element is
+ <code class="code">ANY</code>, detailed descriptions should contain structured
+ DocBook elements that occur within sections, e.g., paragraphs
+ (<code class="sgmltag-element">para</code>, <code class="sgmltag-element">simpara</code>), lists
+ (<code class="sgmltag-element">orderedlist</code>, <code class="sgmltag-element">itemizedlist</code>),
+ tables (<code class="sgmltag-element">informaltable</code>, <code class="sgmltag-element">table</code>),
+ etc.</p>
+</div>
+ <div class="refsection">
+<a name="id1944703"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element destructor</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.destructor"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">destructor</code></span></h2>
+<p>
+ destructor
+ — Declares a destructor for the enclosing class
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>destructor ::=
+ (<a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1944285"></a><h2>Description</h2>
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1944348"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element effects</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.effects"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">effects</code></span></h2>
+<p>
+ effects
+ — Declares the side effects of a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>effects ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1954715"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element enum</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.enum"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">enum</code></span></h2>
+<p>
+ enum
+ — Declares an enumeration type
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>enum ::=
+ (<a class="link" href="enumvalue.html" title="DocBook API Element enumvalue">enumvalue</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1954463"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element enumname</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.enumname"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">enumname</code></span></h2>
+<p>
+ enumname
+ — References an enumeration type with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>enumname ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1953705"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>alt</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element enumvalue</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.enumvalue"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">enumvalue</code></span></h2>
+<p>
+ enumvalue
+ — A single value of an enumeration
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>enumvalue ::=
+ (<a class="link" href="default.html" title="DocBook API Element default">default</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1952394"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element free-function-group</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.free-function-group"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">free-function-group</code></span></h2>
+<p>
+ free-function-group
+ — A set of functions that are grouped together under one name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>free-function-group ::=
+ (<a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>)*
+</div>
+ <div class="refsection">
+<a name="id1947617"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element function</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.function"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">function</code></span></h2>
+<p>
+ function
+ — Declares a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>function ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="parameter.html" title="DocBook API Element parameter">parameter</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1945958"></a><h2>Description</h2>
+ <p>api functions are documented by specifying the
+ function's interface (e.g., its C++ signature) and its
+ behavior. Constructors, destructors, member functions, and free
+ functions all use the same documentation method, although the
+ top-level tags differ.</p>
+
+ <p>The behavior of functions in api is documenting using a
+ style similar to that of the C++ standard, with clauses describing
+ the requirements, effects, postconditions, exception behavior, and
+ return values of functions.</p>
+
+ <p>The following example illustrates some constructors and a
+ destructor for <code class="classname">boost::any</code>. Note that one of
+ the constructors takes a single parameter whose name is "other" and
+ whose type, <code class="code">const any&</code> is contained in the
+ <paramtype> element; any number of parameters may be specified
+ in this way.</p>
+
+ <pre class="programlisting"><class name="any">
+ <constructor>
+ <postconditions><para><this->empty()></para></postconditions>
+ </constructor>
+
+ <constructor>
+ <parameter name="other">
+ <paramtype>const <classname>any</classname>&amp;</paramtype>
+ </parameter>
+
+ <effects>
+ <simpara> Copy constructor that copies
+ content of <code>other</code> into the new instance,
+ so that any content is equivalent in both type and value to the
+ content of <code>other</code>, or empty if
+ <code>other</code> is
+ empty.
+ </simpara>
+ </effects>
+
+ <throws>
+ <simpara>May fail with a
+ <classname>std::bad_alloc</classname> exception or any
+ exceptions arising from the copy constructor of the
+ contained type.
+ </simpara>
+ </throws>
+ </constructor>
+
+ <destructor>
+ <effects><simpara>Releases any and all resources used in
+ management of instance.</simpara></effects>
+
+ <throws><simpara>Nothing.</simpara></throws>
+ </destructor>
+</class></pre>
+</div>
+ <div class="refsection">
+<a name="id1946085"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element functionname</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.functionname"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">functionname</code></span></h2>
+<p>
+ functionname
+ — References a function with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>functionname ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1947751"></a><h2>Description</h2>
+ <p>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 <a class="link" href="using-class.html" title="DocBook API Element using-class"><code class="sgmltag-element">using-class</code></a>
+ and <a class="link" href="using-namespace.html" title="DocBook API Element using-namespace"><code class="sgmltag-element">using-namespace</code></a>
+ directives to aid in the search, along with searching within the
+ current scope.</p>
+</div>
+ <div class="refsection">
+<a name="id1947785"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>alt</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element globalname</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.globalname"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">globalname</code></span></h2>
+<p>
+ globalname
+ — References a global with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>globalname ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1948999"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>alt</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element header</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.header"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">header</code></span></h2>
+<p>
+ header
+ — Declares a C++ header with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>header ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1955245"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element headername</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.headername"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">headername</code></span></h2>
+<p>
+ headername
+ — References a C++ header with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>headername ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1947486"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>alt</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element if-fails</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.if-fails"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">if-fails</code></span></h2>
+<p>
+ if-fails
+ — What it means when a testcase fails
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>if-fails ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1947433"></a><h2>Description</h2>
+ <p>
+ Describes to the user the effect a certain failing testcase will
+ have on the usefulness of a library. This field is useful in cases
+ where a failed testcase does not mean that the library won't be
+ useful, but may mean that certain library features will not be
+ available.
+ </p>
+</div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element inherit</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.inherit"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">inherit</code></span></h2>
+<p>
+ inherit
+ — Declares a base class of the enclosing class or struct
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>inherit ::=
+ (<a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?)
+</div>
+ <div class="refsection">
+<a name="id1945582"></a><h2>Description</h2>
+ <p>This element contains the type of the class inherited.</p>
+</div>
+ <div class="refsection">
+<a name="id1945588"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>access</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The access specifier ("public", "private", or "protected") of the inheritance.</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>pack</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to '1' if this is a pack exapansion.</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element lib</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.lib"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">lib</code></span></h2>
+<p>
+ lib
+ — A library dependency
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>lib ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1954394"></a><h2>Description</h2>
+ <p>Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile.</p>
+</div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element library-reference</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.library-reference"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">library-reference</code></span></h2>
+<p>
+ library-reference
+ — Declares the reference material for a library
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>library-reference ::=
+ (title?, section*, (<a class="link" href="header.html" title="DocBook API Element header">header</a>| <a class="link" href="library-reference.html" title="DocBook API Element library-reference">library-reference</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1944969"></a><h2>Description</h2>
+ <p>Reference documentation for a library is contained with a
+ <library-reference> element. The <library-reference>
+ element has no attributes, and contains as children only
+ <header> elements.</p>
+
+ <p>The <header> element defines a C++ header file. Within
+ each C++ header file lie the definitions of C++ constructs to be
+ documented. The <code class="code">name</code> attribute of the <header>
+ element gives the name of the header, as one would specify when
+ including the header. For instance, the <library-reference>
+ for the <span style="color: red"><libraryname>Any</libraryname></span> library may look like
+ this:</p>
+
+ <pre class="programlisting"><library-reference>
+ <header name="boost/any.hpp">
+ <!-- C++ constructs in this header -->
+ </header>
+</library-reference></pre>
+
+ <p>If the <span style="color: red"><libraryname>Any</libraryname></span> library contained
+ multiple headers, we would list them all as children of the
+ <library-reference> element.</p>
+
+ <p><code class="sgmltag-element">library-reference</code> elements can be nested,
+ so that reference material can be divided into separate sections
+ that each contain different headers.</p>
+</div>
+ <div class="refsection">
+<a name="id1944973"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element library</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.library"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">library</code></span></h2>
+<p>
+ library
+ — Top-level element for a library
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>library ::=
+ (<a class="link" href="libraryinfo.html" title="DocBook API Element libraryinfo">libraryinfo</a>, (title, ((section| <a class="link" href="library-reference.html" title="DocBook API Element library-reference">library-reference</a>| <a class="link" href="testsuite.html" title="DocBook API Element testsuite">testsuite</a>))+)?)
+</div>
+ <div class="refsection">
+<a name="id1953259"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>dirname</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>url</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+<tr>
+<td>html-only</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element librarycategory</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.librarycategory"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">librarycategory</code></span></h2>
+<p>
+ librarycategory
+ — Declares that the enclosing library is in this category
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>librarycategory ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1947914"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element librarycategorydef</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.librarycategorydef"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">librarycategorydef</code></span></h2>
+<p>
+ librarycategorydef
+ — Defines a new library category
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>librarycategorydef ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1952103"></a><h2>Description</h2>
+ <p>All library category definitions should be in the main xml file, and the names of categories must be prefixed with "<code class="code">category:</code>".</p>
+</div>
+ <div class="refsection">
+<a name="id1952114"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element librarycategorylist</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.librarycategorylist"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">librarycategorylist</code></span></h2>
+<p>
+ librarycategorylist
+ — Categorized listing of libraries
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>librarycategorylist ::=
+ (<a class="link" href="librarycategorydef.html" title="DocBook API Element librarycategorydef">librarycategorydef</a>)*
+</div>
+ <div class="refsection">
+<a name="id1953437"></a><h2>Description</h2>
+ <p>This element is used by the main XML document as a
+ placeholder.</p>
+</div>
+ <div class="refsection">
+<a name="id1953436"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element libraryinfo</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.libraryinfo"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">libraryinfo</code></span></h2>
+<p>
+ libraryinfo
+ — Provides information about a library
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>libraryinfo ::=
+ (author+, copyright*, legalnotice*, <a class="link" href="librarypurpose.html" title="DocBook API Element librarypurpose">librarypurpose</a>, <a class="link" href="librarycategory.html" title="DocBook API Element librarycategory">librarycategory</a>*)
+</div>
+ <div class="refsection">
+<a name="id1954968"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element librarylist</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.librarylist"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">librarylist</code></span></h2>
+<p>
+ librarylist
+ — Placeholder for an alphabetical list of libraries
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>librarylist ::=
+ EMPTY
+</div>
+ <div class="refsection">
+<a name="id1944824"></a><h2>Description</h2>
+ <p>Its existence is mainly as a placeholder in the main XML document for the alphabetical list of libraries.</p>
+</div>
+ <div class="refsection">
+<a name="id1944826"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element libraryname</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.libraryname"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">libraryname</code></span></h2>
+<p>
+ libraryname
+ — References a library of the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>libraryname ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1954835"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element librarypurpose</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.librarypurpose"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">librarypurpose</code></span></h2>
+<p>
+ librarypurpose
+ — Describes in one short sentence or phrase the purpose of a library
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>librarypurpose ::=
+ (#PCDATA| <a class="link" href="code.html" title="DocBook API Element code">code</a>| ulink| <a class="link" href="functionname.html" title="DocBook API Element functionname">functionname</a>| methodname| classname| <a class="link" href="macroname.html" title="DocBook API Element macroname">macroname</a>| <a class="link" href="headername.html" title="DocBook API Element headername">headername</a>| <a class="link" href="enumname.html" title="DocBook API Element enumname">enumname</a>| <a class="link" href="globalname.html" title="DocBook API Element globalname">globalname</a>)*
+</div>
+ <div class="refsection">
+<a name="id1949929"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element link-fail-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.link-fail-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">link-fail-test</code></span></h2>
+<p>
+ link-fail-test
+ — Declares a test that should compile but fail to link
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>link-fail-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1943717"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element link-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.link-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">link-test</code></span></h2>
+<p>
+ link-test
+ — Declares a test that should compile and link
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>link-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1943580"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element macroname</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.macroname"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">macroname</code></span></h2>
+<p>
+ macroname
+ — References a macro with the given name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>macroname ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1946227"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>alt</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td> </td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element method-group</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.method-group"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">method-group</code></span></h2>
+<p>
+ method-group
+ — A set of methods that are grouped together under one name
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>method-group ::=
+ (<a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>)*
+</div>
+ <div class="refsection">
+<a name="id1949130"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element method</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.method"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">method</code></span></h2>
+<p>
+ method
+ — Declares a method, i.e., a member function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>method ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="parameter.html" title="DocBook API Element parameter">parameter</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1946679"></a><h2>Description</h2>
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1946604"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>cv</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>cv-qualifiers for this method, e.g., const volatile</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element namespace</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.namespace"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">namespace</code></span></h2>
+<p>
+ namespace
+ — Declares a namespace
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>namespace ::=
+ (<a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="namespace.html" title="DocBook API Element namespace">namespace</a>)*
+</div>
+ <div class="refsection">
+<a name="id1947191"></a><h2>Description</h2>
+ <p>api namespaces are declared via the <namespace>
+ element. As in C++, namespaces can be nested and contain other C++
+ constructs, such as classes or functions. The <code class="code">name</code>
+ attribute of a <namespace> element gives the namespace name
+ (e.g., "boost"). The <span style="color: red"><libraryname>Any</libraryname></span> library is
+ defined entirely within namespace boost by:</p>
+
+ <pre class="programlisting"><library-reference>
+ <header name="boost/any.hpp">
+ <namespace name="boost">
+ <!-- C++ constructs in the boost namespace -->
+ </namespace>
+ </header>
+</library-reference></pre>
+</div>
+ <div class="refsection">
+<a name="id1947303"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element notes</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.notes"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">notes</code></span></h2>
+<p>
+ notes
+ — Non-normative notes about a function's semantics
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>notes ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1948047"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element overloaded-function</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.overloaded-function"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">overloaded-function</code></span></h2>
+<p>
+ overloaded-function
+ — An overloaded function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>overloaded-function ::=
+ (<a class="link" href="signature.html" title="DocBook API Element signature">signature</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1951336"></a><h2>Description</h2>
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1951273"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element overloaded-method</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.overloaded-method"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">overloaded-method</code></span></h2>
+<p>
+ overloaded-method
+ — An overloaded method
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>overloaded-method ::=
+ (<a class="link" href="signature.html" title="DocBook API Element signature">signature</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, <a class="link" href="requires.html" title="DocBook API Element requires">requires</a>?, <a class="link" href="effects.html" title="DocBook API Element effects">effects</a>?, <a class="link" href="postconditions.html" title="DocBook API Element postconditions">postconditions</a>?, <a class="link" href="returns.html" title="DocBook API Element returns">returns</a>?, <a class="link" href="throws.html" title="DocBook API Element throws">throws</a>?, <a class="link" href="complexity.html" title="DocBook API Element complexity">complexity</a>?, <a class="link" href="notes.html" title="DocBook API Element notes">notes</a>?, <a class="link" href="rationale.html" title="DocBook API element rationale">rationale</a>?)
+</div>
+ <div class="refsection">
+<a name="id1952590"></a><h2>Description</h2>
+ <p>General documentation on functions in api is provided in
+ the <a class="link" href="function.html" title="DocBook API Element function"><code class="sgmltag-element">function</code></a>
+ element documentation.</p>
+</div>
+ <div class="refsection">
+<a name="id1952527"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element parameter</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.parameter"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">parameter</code></span></h2>
+<p>
+ parameter
+ — A function parameter
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>parameter ::=
+ (<a class="link" href="paramtype.html" title="DocBook API Element paramtype">paramtype</a>, <a class="link" href="default.html" title="DocBook API Element default">default</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1950983"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>pack</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to '1' if the parameter is a parameter pack.</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element paramtype</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.paramtype"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">paramtype</code></span></h2>
+<p>
+ paramtype
+ — The type of a function parameter
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>paramtype ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1949507"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element postconditions</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.postconditions"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">postconditions</code></span></h2>
+<p>
+ postconditions
+ — Conditions that must hold after the function returns
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>postconditions ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1946346"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element precondition</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.precondition"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">precondition</code></span></h2>
+<p>
+ precondition
+ — Conditions that must be met prior to executing a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>precondition ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1949387"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element programlisting</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.programlisting"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">programlisting</code></span></h2>
+<p>
+ programlisting
+ — A sample of program code
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>programlisting ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1952748"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody><tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr></tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element purpose</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.purpose"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">purpose</code></span></h2>
+<p>
+ purpose
+ — A short description of an entity's use
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>purpose ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1952961"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API element rationale</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.rationale"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API element <code class="sgmltag-element">rationale</code></span></h2>
+<p>
+ rationale
+ — Describes the rationale for a particular function's design
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>rationale ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1955378"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element requirement</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.requirement"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">requirement</code></span></h2>
+<p>
+ requirement
+ — A requirement/property in the Jamfile for a testcase
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>requirement ::=
+ (#PCDATA)
+</div>
+ <div class="refsection">
+<a name="id1949265"></a><h2>Description</h2>
+ <p>A requirement is part of the dependencies of a target in a
+ Jamfile. The <code class="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 class="code"><includes>foo.hpp</code> would be encoded as
+ <code class="code"><requirement
+ name="includes">foo.hpp</requirement></code>.</p>
+</div>
+ <div class="refsection">
+<a name="id1949294"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody><tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr></tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element requires</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.requires"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">requires</code></span></h2>
+<p>
+ requires
+ — Declares the requirements of a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>requires ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1954595"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element returns</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.returns"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">returns</code></span></h2>
+<p>
+ returns
+ — Description of the return value of a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>returns ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1950724"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element run-fail-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.run-fail-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">run-fail-test</code></span></h2>
+<p>
+ run-fail-test
+ — A testcase that should compile and link, but fail on execution
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>run-fail-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1950334"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element run-test</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.run-test"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">run-test</code></span></h2>
+<p>
+ run-test
+ — A testcase that should compile, link, and execute
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>run-test ::=
+ (<a class="link" href="source.html" title="DocBook API Element source">source</a>*, <a class="link" href="lib.html" title="DocBook API Element lib">lib</a>*, <a class="link" href="requirement.html" title="DocBook API Element requirement">requirement</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>, <a class="link" href="if-fails.html" title="DocBook API Element if-fails">if-fails</a>?)
+</div>
+ <div class="refsection">
+<a name="id1949785"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>filename</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the file associated with this element</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element signature</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.signature"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">signature</code></span></h2>
+<p>
+ signature
+ — One signature of an overloaded function or method
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>signature ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="parameter.html" title="DocBook API Element parameter">parameter</a>*)
+</div>
+ <div class="refsection">
+<a name="id1951109"></a><h2>Description</h2>
+ <p>
+ 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.
+ </p>
+</div>
+ <div class="refsection">
+<a name="id1951110"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>cv</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>cv-qualifiers for this method, e.g., const volatile</td>
+</tr>
+<tr>
+<td>specifiers</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>The specifiers for this function, e.g., inline, static, etc.</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element snippet</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.snippet"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">snippet</code></span></h2>
+<p>
+ snippet
+ — Pulls in a code snippet from a <code class="sgmltag-element">programlisting</code> element
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>snippet ::=
+ EMPTY
+</div>
+ <div class="refsection">
+<a name="id1946866"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody><tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the <code class="sgmltag-element">programlisting</code> element to insert</td>
+</tr></tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element source</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.source"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">source</code></span></h2>
+<p>
+ source
+ — Defines source code for a test
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>source ::=
+ (#PCDATA| <a class="link" href="snippet.html" title="DocBook API Element snippet">snippet</a>)*
+</div>
+ <div class="refsection">
+<a name="id1945886"></a><h2>Description</h2>
+ <p>This element will contain the source code for a testcase that
+ will be generated from the documentation. To reduce the amount of escaping in the text, it is recommended to use CDATA sections, which look like this:
+
+ </p>
+<pre class="programlisting"><![CDATA[
+<your program text here: no escaping needed!>
+]]></pre>
+<p>
+ </p>
+
+ <p>In addition to CDATA sections, code snippets can be pulled in
+ from <code class="sgmltag-element">programlisting</code> elements using the <a class="link" href="snippet.html" title="DocBook API Element snippet"><code class="sgmltag-element">snippet</code></a>
+ element.</p>
+</div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element specialization</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.specialization"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">specialization</code></span></h2>
+<p>
+ specialization
+ — Defines the specialization arguments for a class specialization
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>specialization ::=
+ (<a class="link" href="template-arg.html" title="DocBook API Element template-arg">template-arg</a>)*
+</div>
+ <div class="refsection">
+<a name="id1948337"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element static-constant</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.static-constant"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">static-constant</code></span></h2>
+<p>
+ static-constant
+ — Declares a static constant, e.g., <code class="code">const int foo = 5;</code>.
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>static-constant ::=
+ (<a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="default.html" title="DocBook API Element default">default</a>, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1944001"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element struct-specialization</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.struct-specialization"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">struct-specialization</code></span></h2>
+<p>
+ struct-specialization
+ — A specialization (full or partial) of a struct template
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>struct-specialization ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="specialization.html" title="DocBook API Element specialization">specialization</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1953827"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element struct</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.struct"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">struct</code></span></h2>
+<p>
+ struct
+ — Declares a C++ struct
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>struct ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1954121"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element template-arg</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.template-arg"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">template-arg</code></span></h2>
+<p>
+ template-arg
+ — A template argument in a specialization
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>template-arg ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1948867"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>pack</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to '1' if this is a pack exapansion.</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element template-nontype-parameter</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.template-nontype-parameter"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">template-nontype-parameter</code></span></h2>
+<p>
+ template-nontype-parameter
+ — A nontype template parameter
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>template-nontype-parameter ::=
+ (<a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="default.html" title="DocBook API Element default">default</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?)
+</div>
+ <div class="refsection">
+<a name="id1953101"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>pack</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to '1' if the parameter is a parameter pack.</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element template-type-parameter</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.template-type-parameter"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">template-type-parameter</code></span></h2>
+<p>
+ template-type-parameter
+ — Declares a template type parameter
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>template-type-parameter ::=
+ (<a class="link" href="default.html" title="DocBook API Element default">default</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?)
+</div>
+ <div class="refsection">
+<a name="id1944514"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>pack</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to '1' if the parameter is a parameter pack.</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element template-varargs</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.template-varargs"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">template-varargs</code></span></h2>
+<p>
+ template-varargs
+ — Declares a variable-length list of template parameters
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>template-varargs ::=
+ EMPTY
+</div>
+ <div class="refsection">
+<a name="id1945744"></a><h2>Description</h2>
+ <p>Variable-length template parameter lists are not allowed in
+ C++, but because they are sometimes needed in documentation they are
+ allowed in api. This element generally expands to "..." and
+ can be used anywhere any other template parameter can be
+ used.</p>
+</div>
+ <div class="refsection">
+<a name="id1945762"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element template</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.template"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">template</code></span></h2>
+<p>
+ template
+ — Declares the template parameters of a class or function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>template ::=
+ (<a class="link" href="template-type-parameter.html" title="DocBook API Element template-type-parameter">template-type-parameter</a>| <a class="link" href="template-nontype-parameter.html" title="DocBook API Element template-nontype-parameter">template-nontype-parameter</a>| <a class="link" href="template-varargs.html" title="DocBook API Element template-varargs">template-varargs</a>)*
+</div>
+ <div class="refsection">
+<a name="id1950461"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element testsuite</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.testsuite"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">testsuite</code></span></h2>
+<p>
+ testsuite
+ — Describes a library testsuite
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>testsuite ::=
+ ((<a class="link" href="compile-test.html" title="DocBook API Element compile-test">compile-test</a>| <a class="link" href="link-test.html" title="DocBook API Element link-test">link-test</a>| <a class="link" href="run-test.html" title="DocBook API Element run-test">run-test</a>| <a class="link" href="compile-fail-test.html" title="DocBook API Element compile-fail-test">compile-fail-test</a>| <a class="link" href="link-fail-test.html" title="DocBook API Element link-fail-test">link-fail-test</a>| <a class="link" href="run-fail-test.html" title="DocBook API Element run-fail-test">run-fail-test</a>)+)
+</div>
+ <div class="refsection">
+<a name="id1955119"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element throws</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.throws"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">throws</code></span></h2>
+<p>
+ throws
+ — Description of the exceptions thrown by a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>throws ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1948747"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element type</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.type"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">type</code></span></h2>
+<p>
+ type
+ — The type of an element or return type of a function
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>type ::=
+ (ANY)
+</div>
+ <div class="refsection">
+<a name="id1952255"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element typedef</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.typedef"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">typedef</code></span></h2>
+<p>
+ typedef
+ — Declares a typedef
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>typedef ::=
+ (<a class="link" href="type.html" title="DocBook API Element type">type</a>, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?)
+</div>
+ <div class="refsection">
+<a name="id1943843"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element union-specialization</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.union-specialization"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">union-specialization</code></span></h2>
+<p>
+ union-specialization
+ — A specialization (full or partial) of a union template
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>union-specialization ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="specialization.html" title="DocBook API Element specialization">specialization</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>?, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1948467"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element union</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.union"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">union</code></span></h2>
+<p>
+ union
+ — Declares a C++ union or union template
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>union ::=
+ (<a class="link" href="template.html" title="DocBook API Element template">template</a>?, <a class="link" href="inherit.html" title="DocBook API Element inherit">inherit</a>*, <a class="link" href="purpose.html" title="DocBook API Element purpose">purpose</a>?, <a class="link" href="description.html" title="DocBook API Element description">description</a>?, (<a class="link" href="access.html" title="DocBook API Element access">access</a>| <a class="link" href="static-constant.html" title="DocBook API Element static-constant">static-constant</a>| <a class="link" href="typedef.html" title="DocBook API Element typedef">typedef</a>| <a class="link" href="enum.html" title="DocBook API Element enum">enum</a>| <a class="link" href="copy-assignment.html" title="DocBook API Element copy-assignment">copy-assignment</a>| <a class="link" href="constructor.html" title="DocBook API Element constructor">constructor</a>| <a class="link" href="destructor.html" title="DocBook API Element destructor">destructor</a>| <a class="link" href="method-group.html" title="DocBook API Element method-group">method-group</a>| <a class="link" href="free-function-group.html" title="DocBook API Element free-function-group">free-function-group</a>| <a class="link" href="function.html" title="DocBook API Element function">function</a>| <a class="link" href="method.html" title="DocBook API Element method">method</a>| <a class="link" href="overloaded-function.html" title="DocBook API Element overloaded-function">overloaded-function</a>| <a class="link" href="overloaded-method.html" title="DocBook API Element overloaded-method">overloaded-method</a>| <a class="link" href="data-member.html" title="DocBook API Element data-member">data-member</a>| <a class="link" href="class.html" title="DocBook API Element class">class</a>| <a class="link" href="class-specialization.html" title="DocBook API Element class-specialization">class-specialization</a>| <a class="link" href="struct.html" title="DocBook API Element struct">struct</a>| <a class="link" href="struct-specialization.html" title="DocBook API Element struct-specialization">struct-specialization</a>| <a class="link" href="union.html" title="DocBook API Element union">union</a>| <a class="link" href="union-specialization.html" title="DocBook API Element union-specialization">union-specialization</a>)*)
+</div>
+ <div class="refsection">
+<a name="id1945291"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element using-class</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.using-class"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">using-class</code></span></h2>
+<p>
+ using-class
+ — Injects the method and function names of a class into the local scope
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>using-class ::=
+ EMPTY
+</div>
+ <div class="refsection">
+<a name="id1949629"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Element using-namespace</title>
+<link rel="stylesheet" href="../.././api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="../../index.html" title="DocBook API Reference">
+<link rel="up" href="../../index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="../.././images/db.png"></td>
+<td align="center"><a href="../.././index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+<div class="refentry">
+<a name="docbook.api.using-namespace"></a><div class="titlepage"></div>
+
+ <div class="refnamediv">
+<h2><span class="refentrytitle">
+ DocBook API Element <code class="sgmltag-element">using-namespace</code></span></h2>
+<p>
+ using-namespace
+ — Injects the declared names from a namespace into the local scope
+ </p>
+</div>
+ <div class="refsynopsisdiv">
+<h2>Synopsis</h2>using-namespace ::=
+ EMPTY
+</div>
+ <div class="refsection">
+<a name="id1953572"></a><h2>Attributes</h2>
+
+ <div class="informaltable">
+ <table border="1">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>Name</th>
+<th>Type</th>
+<th>Value</th>
+<th>Purpose</th>
+</tr></thead>
+<tbody>
+<tr>
+<td>last-revision</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Set to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes</td>
+</tr>
+<tr>
+<td>name</td>
+<td>#REQUIRED</td>
+<td>CDATA</td>
+<td>The name of the element being declared to referenced</td>
+</tr>
+<tr>
+<td>id</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>A global identifier for this element</td>
+</tr>
+<tr>
+<td>xml:base</td>
+<td>#IMPLIED</td>
+<td>CDATA</td>
+<td>Implementation detail used by XIncludes</td>
+</tr>
+</tbody>
+</table>
+ </div>
+ </div>
+ </div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="u" href="../../index.html"><img src="../.././images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../.././images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>
--- /dev/null
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>DocBook API Reference</title>
+<link rel="stylesheet" href="./api.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<link rel="home" href="index.html" title="DocBook API Reference">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="DocBook API Dcoumentation" width="177" height="86" src="./images/db.png"></td>
+<td align="center"><a href="./index.html">Home</a></td>
+<td align="center"><a href="http://wiki.docbook.org/topic/BoostBookIntegration">Project</a></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"></div>
+<div class="article">
+<div class="titlepage">
+<div><div><h2 class="title">
+<a name="id1943198"></a>DocBook API Reference</h2></div></div>
+<hr>
+</div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/class-specialization.html">
+ DocBook API Element <code class="sgmltag-element">class-specialization</code></a></span><span class="refpurpose"> — A specialization (partial or full) of a class template</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/link-test.html">
+ DocBook API Element <code class="sgmltag-element">link-test</code></a></span><span class="refpurpose"> — Declares a test that should compile and link</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/link-fail-test.html">
+ DocBook API Element <code class="sgmltag-element">link-fail-test</code></a></span><span class="refpurpose"> — Declares a test that should compile but fail to link</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/typedef.html">
+ DocBook API Element <code class="sgmltag-element">typedef</code></a></span><span class="refpurpose"> — Declares a typedef</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/static-constant.html">
+ DocBook API Element <code class="sgmltag-element">static-constant</code></a></span><span class="refpurpose"> — Declares a static constant, e.g., <code class="code">const int foo = 5;</code>.</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/code.html">
+ DocBook API Element <code class="sgmltag-element">code</code></a></span><span class="refpurpose"> — Mimics the <code class="sgmltag-element">code</code> tag in HTML</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/destructor.html">
+ DocBook API Element <code class="sgmltag-element">destructor</code></a></span><span class="refpurpose"> — Declares a destructor for the enclosing class</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/template-type-parameter.html">
+ DocBook API Element <code class="sgmltag-element">template-type-parameter</code></a></span><span class="refpurpose"> — Declares a template type parameter</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/description.html">
+ DocBook API Element <code class="sgmltag-element">description</code></a></span><span class="refpurpose"> — Detailed description of a construct</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/librarylist.html">
+ DocBook API Element <code class="sgmltag-element">librarylist</code></a></span><span class="refpurpose"> — Placeholder for an alphabetical list of libraries</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/library-reference.html">
+ DocBook API Element <code class="sgmltag-element">library-reference</code></a></span><span class="refpurpose"> — Declares the reference material for a library</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/api.html">
+ DocBook API Element <code class="sgmltag-element">api</code></a></span><span class="refpurpose"> — Defines an API</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/union.html">
+ DocBook API Element <code class="sgmltag-element">union</code></a></span><span class="refpurpose"> — Declares a C++ union or union template</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/inherit.html">
+ DocBook API Element <code class="sgmltag-element">inherit</code></a></span><span class="refpurpose"> — Declares a base class of the enclosing class or struct</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/template-varargs.html">
+ DocBook API Element <code class="sgmltag-element">template-varargs</code></a></span><span class="refpurpose"> — Declares a variable-length list of template parameters</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/source.html">
+ DocBook API Element <code class="sgmltag-element">source</code></a></span><span class="refpurpose"> — Defines source code for a test</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/function.html">
+ DocBook API Element <code class="sgmltag-element">function</code></a></span><span class="refpurpose"> — Declares a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/macroname.html">
+ DocBook API Element <code class="sgmltag-element">macroname</code></a></span><span class="refpurpose"> — References a macro with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/postconditions.html">
+ DocBook API Element <code class="sgmltag-element">postconditions</code></a></span><span class="refpurpose"> — Conditions that must hold after the function returns</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/compile-test.html">
+ DocBook API Element <code class="sgmltag-element">compile-test</code></a></span><span class="refpurpose"> — A testcase that should compile correctly</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/method.html">
+ DocBook API Element <code class="sgmltag-element">method</code></a></span><span class="refpurpose"> — Declares a method, i.e., a member function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/snippet.html">
+ DocBook API Element <code class="sgmltag-element">snippet</code></a></span><span class="refpurpose"> — Pulls in a code snippet from a <code class="sgmltag-element">programlisting</code> element</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/constructor.html">
+ DocBook API Element <code class="sgmltag-element">constructor</code></a></span><span class="refpurpose"> — Declares a constructor of the enclosing class</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/namespace.html">
+ DocBook API Element <code class="sgmltag-element">namespace</code></a></span><span class="refpurpose"> — Declares a namespace</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/if-fails.html">
+ DocBook API Element <code class="sgmltag-element">if-fails</code></a></span><span class="refpurpose"> — What it means when a testcase fails</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/headername.html">
+ DocBook API Element <code class="sgmltag-element">headername</code></a></span><span class="refpurpose"> — References a C++ header with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/free-function-group.html">
+ DocBook API Element <code class="sgmltag-element">free-function-group</code></a></span><span class="refpurpose"> — A set of functions that are grouped together under one name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/functionname.html">
+ DocBook API Element <code class="sgmltag-element">functionname</code></a></span><span class="refpurpose"> — References a function with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/librarycategory.html">
+ DocBook API Element <code class="sgmltag-element">librarycategory</code></a></span><span class="refpurpose"> — Declares that the enclosing library is in this category</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/notes.html">
+ DocBook API Element <code class="sgmltag-element">notes</code></a></span><span class="refpurpose"> — Non-normative notes about a function's semantics</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/data-member.html">
+ DocBook API Element <code class="sgmltag-element">data-member</code></a></span><span class="refpurpose"> — Declares a data member of a class</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/specialization.html">
+ DocBook API Element <code class="sgmltag-element">specialization</code></a></span><span class="refpurpose"> — Defines the specialization arguments for a class specialization</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/union-specialization.html">
+ DocBook API Element <code class="sgmltag-element">union-specialization</code></a></span><span class="refpurpose"> — A specialization (full or partial) of a union template</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/throws.html">
+ DocBook API Element <code class="sgmltag-element">throws</code></a></span><span class="refpurpose"> — Description of the exceptions thrown by a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/template-arg.html">
+ DocBook API Element <code class="sgmltag-element">template-arg</code></a></span><span class="refpurpose"> — A template argument in a specialization</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/globalname.html">
+ DocBook API Element <code class="sgmltag-element">globalname</code></a></span><span class="refpurpose"> — References a global with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/method-group.html">
+ DocBook API Element <code class="sgmltag-element">method-group</code></a></span><span class="refpurpose"> — A set of methods that are grouped together under one name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/requirement.html">
+ DocBook API Element <code class="sgmltag-element">requirement</code></a></span><span class="refpurpose"> — A requirement/property in the Jamfile for a testcase</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/precondition.html">
+ DocBook API Element <code class="sgmltag-element">precondition</code></a></span><span class="refpurpose"> — Conditions that must be met prior to executing a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/paramtype.html">
+ DocBook API Element <code class="sgmltag-element">paramtype</code></a></span><span class="refpurpose"> — The type of a function parameter</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/using-class.html">
+ DocBook API Element <code class="sgmltag-element">using-class</code></a></span><span class="refpurpose"> — Injects the method and function names of a class into the local scope</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/run-test.html">
+ DocBook API Element <code class="sgmltag-element">run-test</code></a></span><span class="refpurpose"> — A testcase that should compile, link, and execute</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/librarypurpose.html">
+ DocBook API Element <code class="sgmltag-element">librarypurpose</code></a></span><span class="refpurpose"> — Describes in one short sentence or phrase the purpose of a library</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/copy-assignment.html">
+ DocBook API Element <code class="sgmltag-element">copy-assignment</code></a></span><span class="refpurpose"> — Declares a copy-assignment operator</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/run-fail-test.html">
+ DocBook API Element <code class="sgmltag-element">run-fail-test</code></a></span><span class="refpurpose"> — A testcase that should compile and link, but fail on execution</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/template.html">
+ DocBook API Element <code class="sgmltag-element">template</code></a></span><span class="refpurpose"> — Declares the template parameters of a class or function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/compile-fail-test.html">
+ DocBook API Element <code class="sgmltag-element">compile-fail-test</code></a></span><span class="refpurpose"> — A testcase that should fail to compile</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/returns.html">
+ DocBook API Element <code class="sgmltag-element">returns</code></a></span><span class="refpurpose"> — Description of the return value of a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/default.html">
+ DocBook API Element <code class="sgmltag-element">default</code></a></span><span class="refpurpose"> — The default value of a function or template parameter</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/parameter.html">
+ DocBook API Element <code class="sgmltag-element">parameter</code></a></span><span class="refpurpose"> — A function parameter</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/signature.html">
+ DocBook API Element <code class="sgmltag-element">signature</code></a></span><span class="refpurpose"> — One signature of an overloaded function or method</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/overloaded-function.html">
+ DocBook API Element <code class="sgmltag-element">overloaded-function</code></a></span><span class="refpurpose"> — An overloaded function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/access.html">
+ DocBook API Element <code class="sgmltag-element">access</code></a></span><span class="refpurpose"> — Declares an access specification for class members</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/class.html">
+ DocBook API Element <code class="sgmltag-element">class</code></a></span><span class="refpurpose"> — Declares a class or class template</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/librarycategorydef.html">
+ DocBook API Element <code class="sgmltag-element">librarycategorydef</code></a></span><span class="refpurpose"> — Defines a new library category</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/type.html">
+ DocBook API Element <code class="sgmltag-element">type</code></a></span><span class="refpurpose"> — The type of an element or return type of a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/enumvalue.html">
+ DocBook API Element <code class="sgmltag-element">enumvalue</code></a></span><span class="refpurpose"> — A single value of an enumeration</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/overloaded-method.html">
+ DocBook API Element <code class="sgmltag-element">overloaded-method</code></a></span><span class="refpurpose"> — An overloaded method</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/programlisting.html">
+ DocBook API Element <code class="sgmltag-element">programlisting</code></a></span><span class="refpurpose"> — A sample of program code</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/complexity.html">
+ DocBook API Element <code class="sgmltag-element">complexity</code></a></span><span class="refpurpose"> — The time/space/etc. complexity of a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/purpose.html">
+ DocBook API Element <code class="sgmltag-element">purpose</code></a></span><span class="refpurpose"> — A short description of an entity's use</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/template-nontype-parameter.html">
+ DocBook API Element <code class="sgmltag-element">template-nontype-parameter</code></a></span><span class="refpurpose"> — A nontype template parameter</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/library.html">
+ DocBook API Element <code class="sgmltag-element">library</code></a></span><span class="refpurpose"> — Top-level element for a library</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/librarycategorylist.html">
+ DocBook API Element <code class="sgmltag-element">librarycategorylist</code></a></span><span class="refpurpose"> — Categorized listing of libraries</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/using-namespace.html">
+ DocBook API Element <code class="sgmltag-element">using-namespace</code></a></span><span class="refpurpose"> — Injects the declared names from a namespace into the local scope</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/enumname.html">
+ DocBook API Element <code class="sgmltag-element">enumname</code></a></span><span class="refpurpose"> — References an enumeration type with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/struct-specialization.html">
+ DocBook API Element <code class="sgmltag-element">struct-specialization</code></a></span><span class="refpurpose"> — A specialization (full or partial) of a struct template</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/struct.html">
+ DocBook API Element <code class="sgmltag-element">struct</code></a></span><span class="refpurpose"> — Declares a C++ struct</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/lib.html">
+ DocBook API Element <code class="sgmltag-element">lib</code></a></span><span class="refpurpose"> — A library dependency</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/enum.html">
+ DocBook API Element <code class="sgmltag-element">enum</code></a></span><span class="refpurpose"> — Declares an enumeration type</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/requires.html">
+ DocBook API Element <code class="sgmltag-element">requires</code></a></span><span class="refpurpose"> — Declares the requirements of a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/effects.html">
+ DocBook API Element <code class="sgmltag-element">effects</code></a></span><span class="refpurpose"> — Declares the side effects of a function</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/libraryname.html">
+ DocBook API Element <code class="sgmltag-element">libraryname</code></a></span><span class="refpurpose"> — References a library of the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/libraryinfo.html">
+ DocBook API Element <code class="sgmltag-element">libraryinfo</code></a></span><span class="refpurpose"> — Provides information about a library</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/testsuite.html">
+ DocBook API Element <code class="sgmltag-element">testsuite</code></a></span><span class="refpurpose"> — Describes a library testsuite</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/header.html">
+ DocBook API Element <code class="sgmltag-element">header</code></a></span><span class="refpurpose"> — Declares a C++ header with the given name</span>
+</dt>
+<dt>
+<span class="refentrytitle"><a href="docbook/api/rationale.html">
+ DocBook API element <code class="sgmltag-element">rationale</code></a></span><span class="refpurpose"> — Describes the rationale for a particular function's design</span>
+</dt>
+</dl>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer"></div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"></div>
+</body>
+</html>
<!-- Converted by db4-upgrade version 1.0 -->
<article xmlns="http://docbook.org/ns/docbook" version="5.0"><info><title>DocBook API Reference</title></info>
-<!--
- <para>Elements:<itemizedlist spacing="compact"><listitem><simpara><link linkend="api.grammar.access">Element <tag>access</tag> - Declares an access specification for class members</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.api">Element <tag>api</tag> - Defines a DocBook API book</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.class">Element <tag>class</tag> - Declares a class or class template</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.class-specialization">Element <tag>class-specialization</tag> - A specialization (partial or full) of a class template</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.code">Element <tag>code</tag> - Mimics the <tag>code</tag> tag in HTML</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.compile-fail-test">Element <tag>compile-fail-test</tag> - A testcase that should fail to compile</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.compile-test">Element <tag>compile-test</tag> - A testcase that should compile correctly</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.complexity">Element <tag>complexity</tag> - The time/space/etc. complexity of a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.constructor">Element <tag>constructor</tag> - Declares a constructor of the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.copy-assignment">Element <tag>copy-assignment</tag> - Declares a copy-assignment operator</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.data-member">Element <tag>data-member</tag> - Declares a data member of a class</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.default">Element <tag>default</tag> - The default value of a function or template parameter</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.description">Element <tag>description</tag> - Detailed description of a construct</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.destructor">Element <tag>destructor</tag> - Declares a destructor for the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.effects">Element <tag>effects</tag> - Declares the side effects of a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.enum">Element <tag>enum</tag> - Declares an enumeration type</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.enumname">Element <tag>enumname</tag> - References an enumeration type with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.enumvalue">Element <tag>enumvalue</tag> - A single value of an enumeration</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.free-function-group">Element <tag>free-function-group</tag> - A set of functions that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.function">Element <tag>function</tag> - Declares a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.functionname">Element <tag>functionname</tag> - References a function with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.globalname">Element <tag>globalname</tag> - References a global with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.header">Element <tag>header</tag> - Declares a C++ header with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.headername">Element <tag>headername</tag> - References a C++ header with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.if-fails">Element <tag>if-fails</tag> - What it means when a testcase fails</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.inherit">Element <tag>inherit</tag> - Declares a base class of the enclosing class or struct</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.lib">Element <tag>lib</tag> - A library dependency</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.library">Element <tag>library</tag> - Top-level element for a library</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.library-reference">Element <tag>library-reference</tag> - Declares the reference material for a library</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.librarycategory">Element <tag>librarycategory</tag> - Declares that the enclosing library is in this category</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.librarycategorydef">Element <tag>librarycategorydef</tag> - Defines a new library category</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.librarycategorylist">Element <tag>librarycategorylist</tag> - Categorized listing of libraries</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.libraryinfo">Element <tag>libraryinfo</tag> - Provides information about a library</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.librarylist">Element <tag>librarylist</tag> - Placeholder for an alphabetical list of libraries</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.libraryname">Element <tag>libraryname</tag> - References a library of the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.librarypurpose">Element <tag>librarypurpose</tag> - Describes in one short sentence or phrase the purpose of a library</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.link-fail-test">Element <tag>link-fail-test</tag> - Declares a test that should compile but fail to link</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.link-test">Element <tag>link-test</tag> - Declares a test that should compile and link</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.macroname">Element <tag>macroname</tag> - References a macro with the given name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.method">Element <tag>method</tag> - Declares a method, i.e., a member function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.method-group">Element <tag>method-group</tag> - A set of methods that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.namespace">Element <tag>namespace</tag> - Declares a namespace</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.notes">Element <tag>notes</tag> - Non-normative notes about a function's semantics</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.overloaded-function">Element <tag>overloaded-function</tag> - An overloaded function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.overloaded-method">Element <tag>overloaded-method</tag> - An overloaded method</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.parameter">Element <tag>parameter</tag> - A function parameter</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.paramtype">Element <tag>paramtype</tag> - The type of a function parameter</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.postconditions">Element <tag>postconditions</tag> - Conditions that must hold after the function returns</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.precondition">Element <tag>precondition</tag> - Conditions that must be met prior to executing a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.programlisting">Element <tag>programlisting</tag> - A sample of program code</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.purpose">Element <tag>purpose</tag> - A short description of an entity's use</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.rationale">Element <tag>rationale</tag> - Describes the rationale for a particular function's design</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.requirement">Element <tag>requirement</tag> - A requirement/property in the Jamfile for a testcase</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.requires">Element <tag>requires</tag> - Declares the requirements of a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.returns">Element <tag>returns</tag> - Description of the return value of a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.run-fail-test">Element <tag>run-fail-test</tag> - A testcase that should compile and link, but fail on execution</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.run-test">Element <tag>run-test</tag> - A testcase that should compile, link, and execute</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.signature">Element <tag>signature</tag> - One signature of an overloaded function or method</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.snippet">Element <tag>snippet</tag> - Pulls in a code snippet from a <tag>programlisting</tag> element</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.source">Element <tag>source</tag> - Defines source code for a test</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.specialization">Element <tag>specialization</tag> - Defines the specialization arguments for a class specialization</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.static-constant">Element <tag>static-constant</tag> - Declares a static constant, e.g., <code>const int foo = 5;</code>.</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.struct">Element <tag>struct</tag> - Declares a C++ struct</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.struct-specialization">Element <tag>struct-specialization</tag> - A specialization (full or partial) of a struct template</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.template">Element <tag>template</tag> - Declares the template parameters of a class or function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.template-arg">Element <tag>template-arg</tag> - A template argument in a specialization</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.template-nontype-parameter">Element <tag>template-nontype-parameter</tag> - A nontype template parameter</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.template-type-parameter">Element <tag>template-type-parameter</tag> - Declares a template type parameter</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.template-varargs">Element <tag>template-varargs</tag> - Declares a variable-length list of template parameters</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.testsuite">Element <tag>testsuite</tag> - Describes a library testsuite</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.throws">Element <tag>throws</tag> - Description of the exceptions thrown by a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.type">Element <tag>type</tag> - The type of an element or return type of a function</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.typedef">Element <tag>typedef</tag> - Declares a typedef</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.union">Element <tag>union</tag> - Declares a C++ union or union template</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.union-specialization">Element <tag>union-specialization</tag> - A specialization (full or partial) of a union template</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.using-class">Element <tag>using-class</tag> - Injects the method and function names of a class into the local scope</link></simpara></listitem><listitem><simpara><link linkend="api.grammar.using-namespace">Element <tag>using-namespace</tag> - Injects the declared names from a namespace into the local scope</link></simpara></listitem></itemizedlist></para>
+ <!--
+ <para>Elements:<itemizedlist spacing="compact"><listitem><simpara><link linkend="docbook.api.access">Element <tag>access</tag> - Declares an access specification for class members</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.api">Element <tag>api</tag> - Defines a DocBook API</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.class">Element <tag>class</tag> - Declares a class or class template</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.class-specialization">Element <tag>class-specialization</tag> - A specialization (partial or full) of a class template</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.code">Element <tag>code</tag> - Mimics the <tag>code</tag> tag in HTML</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.compile-fail-test">Element <tag>compile-fail-test</tag> - A testcase that should fail to compile</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.compile-test">Element <tag>compile-test</tag> - A testcase that should compile correctly</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.complexity">Element <tag>complexity</tag> - The time/space/etc. complexity of a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.constructor">Element <tag>constructor</tag> - Declares a constructor of the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.copy-assignment">Element <tag>copy-assignment</tag> - Declares a copy-assignment operator</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.data-member">Element <tag>data-member</tag> - Declares a data member of a class</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.default">Element <tag>default</tag> - The default value of a function or template parameter</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.description">Element <tag>description</tag> - Detailed description of a construct</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.destructor">Element <tag>destructor</tag> - Declares a destructor for the enclosing class</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.effects">Element <tag>effects</tag> - Declares the side effects of a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.enum">Element <tag>enum</tag> - Declares an enumeration type</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.enumname">Element <tag>enumname</tag> - References an enumeration type with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.enumvalue">Element <tag>enumvalue</tag> - A single value of an enumeration</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.free-function-group">Element <tag>free-function-group</tag> - A set of functions that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.function">Element <tag>function</tag> - Declares a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.functionname">Element <tag>functionname</tag> - References a function with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.globalname">Element <tag>globalname</tag> - References a global with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.header">Element <tag>header</tag> - Declares a C++ header with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.headername">Element <tag>headername</tag> - References a C++ header with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.if-fails">Element <tag>if-fails</tag> - What it means when a testcase fails</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.inherit">Element <tag>inherit</tag> - Declares a base class of the enclosing class or struct</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.lib">Element <tag>lib</tag> - A library dependency</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.library">Element <tag>library</tag> - Top-level element for a library</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.library-reference">Element <tag>library-reference</tag> - Declares the reference material for a library</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.librarycategory">Element <tag>librarycategory</tag> - Declares that the enclosing library is in this category</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.librarycategorydef">Element <tag>librarycategorydef</tag> - Defines a new library category</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.librarycategorylist">Element <tag>librarycategorylist</tag> - Categorized listing of libraries</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.libraryinfo">Element <tag>libraryinfo</tag> - Provides information about a library</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.librarylist">Element <tag>librarylist</tag> - Placeholder for an alphabetical list of libraries</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.libraryname">Element <tag>libraryname</tag> - References a library of the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.librarypurpose">Element <tag>librarypurpose</tag> - Describes in one short sentence or phrase the purpose of a library</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.link-fail-test">Element <tag>link-fail-test</tag> - Declares a test that should compile but fail to link</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.link-test">Element <tag>link-test</tag> - Declares a test that should compile and link</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.macroname">Element <tag>macroname</tag> - References a macro with the given name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.method">Element <tag>method</tag> - Declares a method, i.e., a member function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.method-group">Element <tag>method-group</tag> - A set of methods that are grouped together under one name</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.namespace">Element <tag>namespace</tag> - Declares a namespace</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.notes">Element <tag>notes</tag> - Non-normative notes about a function's semantics</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.overloaded-function">Element <tag>overloaded-function</tag> - An overloaded function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.overloaded-method">Element <tag>overloaded-method</tag> - An overloaded method</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.parameter">Element <tag>parameter</tag> - A function parameter</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.paramtype">Element <tag>paramtype</tag> - The type of a function parameter</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.postconditions">Element <tag>postconditions</tag> - Conditions that must hold after the function returns</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.precondition">Element <tag>precondition</tag> - Conditions that must be met prior to executing a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.programlisting">Element <tag>programlisting</tag> - A sample of program code</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.purpose">Element <tag>purpose</tag> - A short description of an entity's use</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.rationale">Element <tag>rationale</tag> - Describes the rationale for a particular function's design</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.requirement">Element <tag>requirement</tag> - A requirement/property in the Jamfile for a testcase</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.requires">Element <tag>requires</tag> - Declares the requirements of a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.returns">Element <tag>returns</tag> - Description of the return value of a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.run-fail-test">Element <tag>run-fail-test</tag> - A testcase that should compile and link, but fail on execution</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.run-test">Element <tag>run-test</tag> - A testcase that should compile, link, and execute</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.signature">Element <tag>signature</tag> - One signature of an overloaded function or method</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.snippet">Element <tag>snippet</tag> - Pulls in a code snippet from a <tag>programlisting</tag> element</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.source">Element <tag>source</tag> - Defines source code for a test</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.specialization">Element <tag>specialization</tag> - Defines the specialization arguments for a class specialization</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.static-constant">Element <tag>static-constant</tag> - Declares a static constant, e.g., <code>const int foo = 5;</code>.</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.struct">Element <tag>struct</tag> - Declares a C++ struct</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.struct-specialization">Element <tag>struct-specialization</tag> - A specialization (full or partial) of a struct template</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.template">Element <tag>template</tag> - Declares the template parameters of a class or function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.template-arg">Element <tag>template-arg</tag> - A template argument in a specialization</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.template-nontype-parameter">Element <tag>template-nontype-parameter</tag> - A nontype template parameter</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.template-type-parameter">Element <tag>template-type-parameter</tag> - Declares a template type parameter</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.template-varargs">Element <tag>template-varargs</tag> - Declares a variable-length list of template parameters</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.testsuite">Element <tag>testsuite</tag> - Describes a library testsuite</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.throws">Element <tag>throws</tag> - Description of the exceptions thrown by a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.type">Element <tag>type</tag> - The type of an element or return type of a function</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.typedef">Element <tag>typedef</tag> - Declares a typedef</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.union">Element <tag>union</tag> - Declares a C++ union or union template</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.union-specialization">Element <tag>union-specialization</tag> - A specialization (full or partial) of a union template</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.using-class">Element <tag>using-class</tag> - Injects the method and function names of a class into the local scope</link></simpara></listitem><listitem><simpara><link linkend="docbook.api.using-namespace">Element <tag>using-namespace</tag> - Injects the declared names from a namespace into the local scope</link></simpara></listitem></itemizedlist></para>
-->
- <refentry xml:id="api.grammar.class-specialization">
+ <refentry xml:id="docbook.api.class-specialization">
<refmeta>
<refentrytitle>
DocBook API Element <tag>class-specialization</tag></refentrytitle>
<refpurpose>A specialization (partial or full) of a class template</refpurpose>
</refnamediv>
<refsynopsisdiv>class-specialization ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.specialization">specialization</link>?, <link linkend="api.grammar.inherit">inherit</link>?, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.specialization">specialization</link>?, <link linkend="docbook.api.inherit">inherit</link>?, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.link-test">
+ <refentry xml:id="docbook.api.link-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>link-test</tag></refentrytitle>
<refpurpose>Declares a test that should compile and link</refpurpose>
</refnamediv>
<refsynopsisdiv>link-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.link-fail-test">
+ <refentry xml:id="docbook.api.link-fail-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>link-fail-test</tag></refentrytitle>
<refpurpose>Declares a test that should compile but fail to link</refpurpose>
</refnamediv>
<refsynopsisdiv>link-fail-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.typedef">
+ <refentry xml:id="docbook.api.typedef">
<refmeta>
<refentrytitle>
DocBook API Element <tag>typedef</tag></refentrytitle>
<refpurpose>Declares a typedef</refpurpose>
</refnamediv>
<refsynopsisdiv>typedef ::=
- (<link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.static-constant">
+ <refentry xml:id="docbook.api.static-constant">
<refmeta>
<refentrytitle>
DocBook API Element <tag>static-constant</tag></refentrytitle>
<refpurpose>Declares a static constant, e.g., <code>const int foo = 5;</code>.</refpurpose>
</refnamediv>
<refsynopsisdiv>static-constant ::=
- (<link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.default">default</link>, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.default">default</link>, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.code">
+ <refentry xml:id="docbook.api.code">
<refmeta>
<refentrytitle>
DocBook API Element <tag>code</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.destructor">
+ <refentry xml:id="docbook.api.destructor">
<refmeta>
<refentrytitle>
DocBook API Element <tag>destructor</tag></refentrytitle>
<refpurpose>Declares a destructor for the enclosing class</refpurpose>
</refnamediv>
<refsynopsisdiv>destructor ::=
- (<link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.template-type-parameter">
+ <refentry xml:id="docbook.api.template-type-parameter">
<refmeta>
<refentrytitle>
DocBook API Element <tag>template-type-parameter</tag></refentrytitle>
<refpurpose>Declares a template type parameter</refpurpose>
</refnamediv>
<refsynopsisdiv>template-type-parameter ::=
- (<link linkend="api.grammar.default">default</link>?, <link linkend="api.grammar.purpose">purpose</link>?)
+ (<link linkend="docbook.api.default">default</link>?, <link linkend="docbook.api.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.description">
+ <refentry xml:id="docbook.api.description">
<refmeta>
<refentrytitle>
DocBook API Element <tag>description</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.librarylist">
+ <refentry xml:id="docbook.api.librarylist">
<refmeta>
<refentrytitle>
DocBook API Element <tag>librarylist</tag></refentrytitle>
EMPTY
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
- <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>
+ <para>Its existence is mainly as a placeholder in the main XML document for the alphabetical list of libraries.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.library-reference">
+ <refentry xml:id="docbook.api.library-reference">
<refmeta>
<refentrytitle>
DocBook API Element <tag>library-reference</tag></refentrytitle>
<refpurpose>Declares the reference material for a library</refpurpose>
</refnamediv>
<refsynopsisdiv>library-reference ::=
- (title?, section*, (<link linkend="api.grammar.header">header</link>| <link linkend="api.grammar.library-reference">library-reference</link>)*)
+ (title?, section*, (<link linkend="docbook.api.header">header</link>| <link linkend="docbook.api.library-reference">library-reference</link>)*)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>Reference documentation for a library is contained with a
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.api">
+ <refentry xml:id="docbook.api.api">
<refmeta>
<refentrytitle>
DocBook API Element <tag>api</tag></refentrytitle>
</refmeta>
<refnamediv>
<refname>api</refname>
- <refpurpose>Defines a api book</refpurpose>
+ <refpurpose>Defines an API</refpurpose>
</refnamediv>
<refsynopsisdiv>api ::=
- (title, (chapter| <link linkend="api.grammar.library">library</link>)*)
+ (title, (chapter| <link linkend="docbook.api.library">library</link>)*)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<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>
+ main XML file for all API documentation</simpara>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.union">
+ <refentry xml:id="docbook.api.union">
<refmeta>
<refentrytitle>
DocBook API Element <tag>union</tag></refentrytitle>
<refpurpose>Declares a C++ union or union template</refpurpose>
</refnamediv>
<refsynopsisdiv>union ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.inherit">inherit</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.inherit">inherit</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.inherit">
+ <refentry xml:id="docbook.api.inherit">
<refmeta>
<refentrytitle>
DocBook API Element <tag>inherit</tag></refentrytitle>
<refpurpose>Declares a base class of the enclosing class or struct</refpurpose>
</refnamediv>
<refsynopsisdiv>inherit ::=
- (<link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.purpose">purpose</link>?)
+ (<link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This element contains the type of the class inherited.</para>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.template-varargs">
+ <refentry xml:id="docbook.api.template-varargs">
<refmeta>
<refentrytitle>
DocBook API Element <tag>template-varargs</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.source">
+ <refentry xml:id="docbook.api.source">
<refmeta>
<refentrytitle>
DocBook API Element <tag>source</tag></refentrytitle>
<refpurpose>Defines source code for a test</refpurpose>
</refnamediv>
<refsynopsisdiv>source ::=
- (#PCDATA| <link linkend="api.grammar.snippet">snippet</link>)*
+ (#PCDATA| <link linkend="docbook.api.snippet">snippet</link>)*
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>This element will contain the source code for a testcase that
</para>
<para>In addition to CDATA sections, code snippets can be pulled in
- from <tag>programlisting</tag> elements using the <link linkend="api.grammar.snippet"><tag>snippet</tag></link>
+ from <tag>programlisting</tag> elements using the <link linkend="docbook.api.snippet"><tag>snippet</tag></link>
element.</para>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.function">
+ <refentry xml:id="docbook.api.function">
<refmeta>
<refentrytitle>
DocBook API Element <tag>function</tag></refentrytitle>
<refpurpose>Declares a function</refpurpose>
</refnamediv>
<refsynopsisdiv>function ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.parameter">parameter</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.parameter">parameter</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>api functions are documented by specifying the
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.macroname">
+ <refentry xml:id="docbook.api.macroname">
<refmeta>
<refentrytitle>
DocBook API Element <tag>macroname</tag></refentrytitle>
</refmeta>
<refnamediv>
<refname>macroname</refname>
- <refpurpose/>
+ <refpurpose>References a macro with the given name</refpurpose>
</refnamediv>
<refsynopsisdiv>macroname ::=
(#PCDATA)
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.postconditions">
+ <refentry xml:id="docbook.api.postconditions">
<refmeta>
<refentrytitle>
DocBook API Element <tag>postconditions</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.compile-test">
+ <refentry xml:id="docbook.api.compile-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>compile-test</tag></refentrytitle>
<refpurpose>A testcase that should compile correctly</refpurpose>
</refnamediv>
<refsynopsisdiv>compile-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.method">
+ <refentry xml:id="docbook.api.method">
<refmeta>
<refentrytitle>
DocBook API Element <tag>method</tag></refentrytitle>
<refpurpose>Declares a method, i.e., a member function</refpurpose>
</refnamediv>
<refsynopsisdiv>method ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.parameter">parameter</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.parameter">parameter</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.snippet">
+ <refentry xml:id="docbook.api.snippet">
<refmeta>
<refentrytitle>
DocBook API Element <tag>snippet</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.constructor">
+ <refentry xml:id="docbook.api.constructor">
<refmeta>
<refentrytitle>
DocBook API Element <tag>constructor</tag></refentrytitle>
<refpurpose>Declares a constructor of the enclosing class</refpurpose>
</refnamediv>
<refsynopsisdiv>constructor ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.parameter">parameter</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.parameter">parameter</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.namespace">
+ <refentry xml:id="docbook.api.namespace">
<refmeta>
<refentrytitle>
DocBook API Element <tag>namespace</tag></refentrytitle>
<refpurpose>Declares a namespace</refpurpose>
</refnamediv>
<refsynopsisdiv>namespace ::=
- (<link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.namespace">namespace</link>)*
+ (<link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.namespace">namespace</link>)*
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>api namespaces are declared via the <namespace>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.if-fails">
+ <refentry xml:id="docbook.api.if-fails">
<refmeta>
<refentrytitle>
DocBook API Element <tag>if-fails</tag></refentrytitle>
</para>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.headername">
+ <refentry xml:id="docbook.api.headername">
<refmeta>
<refentrytitle>
DocBook API Element <tag>headername</tag></refentrytitle>
</refmeta>
<refnamediv>
<refname>headername</refname>
- <refpurpose/>
+ <refpurpose>References a C++ header with the given name</refpurpose>
</refnamediv>
<refsynopsisdiv>headername ::=
(#PCDATA)
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.free-function-group">
+ <refentry xml:id="docbook.api.free-function-group">
<refmeta>
<refentrytitle>
DocBook API Element <tag>free-function-group</tag></refentrytitle>
<refpurpose>A set of functions that are grouped together under one name</refpurpose>
</refnamediv>
<refsynopsisdiv>free-function-group ::=
- (<link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>)*
+ (<link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>)*
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.functionname">
+ <refentry xml:id="docbook.api.functionname">
<refmeta>
<refentrytitle>
DocBook API Element <tag>functionname</tag></refentrytitle>
<refsection><info><title>Description</title></info>
<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="api.grammar.using-class"><tag>using-class</tag></link>
- and <link linkend="api.grammar.using-namespace"><tag>using-namespace</tag></link>
+ function. Lookups obey currently-active <link linkend="docbook.api.using-class"><tag>using-class</tag></link>
+ and <link linkend="docbook.api.using-namespace"><tag>using-namespace</tag></link>
directives to aid in the search, along with searching within the
current scope.</para>
</refsection>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.librarycategory">
+ <refentry xml:id="docbook.api.librarycategory">
<refmeta>
<refentrytitle>
DocBook API Element <tag>librarycategory</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.notes">
+ <refentry xml:id="docbook.api.notes">
<refmeta>
<refentrytitle>
DocBook API Element <tag>notes</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.data-member">
+ <refentry xml:id="docbook.api.data-member">
<refmeta>
<refentrytitle>
DocBook API Element <tag>data-member</tag></refentrytitle>
<refpurpose>Declares a data member of a class</refpurpose>
</refnamediv>
<refsynopsisdiv>data-member ::=
- (<link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.specialization">
+ <refentry xml:id="docbook.api.specialization">
<refmeta>
<refentrytitle>
DocBook API Element <tag>specialization</tag></refentrytitle>
<refpurpose>Defines the specialization arguments for a class specialization</refpurpose>
</refnamediv>
<refsynopsisdiv>specialization ::=
- (<link linkend="api.grammar.template-arg">template-arg</link>)*
+ (<link linkend="docbook.api.template-arg">template-arg</link>)*
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.union-specialization">
+ <refentry xml:id="docbook.api.union-specialization">
<refmeta>
<refentrytitle>
DocBook API Element <tag>union-specialization</tag></refentrytitle>
<refpurpose>A specialization (full or partial) of a union template</refpurpose>
</refnamediv>
<refsynopsisdiv>union-specialization ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.specialization">specialization</link>?, <link linkend="api.grammar.inherit">inherit</link>?, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.specialization">specialization</link>?, <link linkend="docbook.api.inherit">inherit</link>?, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.throws">
+ <refentry xml:id="docbook.api.throws">
<refmeta>
<refentrytitle>
DocBook API Element <tag>throws</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.template-arg">
+ <refentry xml:id="docbook.api.template-arg">
<refmeta>
<refentrytitle>
DocBook API Element <tag>template-arg</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.globalname">
+ <refentry xml:id="docbook.api.globalname">
<refmeta>
<refentrytitle>
DocBook API Element <tag>globalname</tag></refentrytitle>
</refmeta>
<refnamediv>
<refname>globalname</refname>
- <refpurpose/>
+ <refpurpose>References a global with the given name</refpurpose>
</refnamediv>
<refsynopsisdiv>globalname ::=
(#PCDATA)
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.method-group">
+ <refentry xml:id="docbook.api.method-group">
<refmeta>
<refentrytitle>
DocBook API Element <tag>method-group</tag></refentrytitle>
<refpurpose>A set of methods that are grouped together under one name</refpurpose>
</refnamediv>
<refsynopsisdiv>method-group ::=
- (<link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>)*
+ (<link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>)*
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.requirement">
+ <refentry xml:id="docbook.api.requirement">
<refmeta>
<refentrytitle>
DocBook API Element <tag>requirement</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.precondition">
+ <refentry xml:id="docbook.api.precondition">
<refmeta>
<refentrytitle>
DocBook API Element <tag>precondition</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.paramtype">
+ <refentry xml:id="docbook.api.paramtype">
<refmeta>
<refentrytitle>
DocBook API Element <tag>paramtype</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.using-class">
+ <refentry xml:id="docbook.api.using-class">
<refmeta>
<refentrytitle>
DocBook API Element <tag>using-class</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.run-test">
+ <refentry xml:id="docbook.api.run-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>run-test</tag></refentrytitle>
<refpurpose>A testcase that should compile, link, and execute</refpurpose>
</refnamediv>
<refsynopsisdiv>run-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.librarypurpose">
+ <refentry xml:id="docbook.api.librarypurpose">
<refmeta>
<refentrytitle>
DocBook API Element <tag>librarypurpose</tag></refentrytitle>
<refpurpose>Describes in one short sentence or phrase the purpose of a library</refpurpose>
</refnamediv>
<refsynopsisdiv>librarypurpose ::=
- (#PCDATA| <link linkend="api.grammar.code">code</link>| ulink| <link linkend="api.grammar.functionname">functionname</link>| methodname| classname| <link linkend="api.grammar.macroname">macroname</link>| <link linkend="api.grammar.headername">headername</link>| <link linkend="api.grammar.enumname">enumname</link>| <link linkend="api.grammar.globalname">globalname</link>)*
+ (#PCDATA| <link linkend="docbook.api.code">code</link>| ulink| <link linkend="docbook.api.functionname">functionname</link>| methodname| classname| <link linkend="docbook.api.macroname">macroname</link>| <link linkend="docbook.api.headername">headername</link>| <link linkend="docbook.api.enumname">enumname</link>| <link linkend="docbook.api.globalname">globalname</link>)*
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.copy-assignment">
+ <refentry xml:id="docbook.api.copy-assignment">
<refmeta>
<refentrytitle>
DocBook API Element <tag>copy-assignment</tag></refentrytitle>
<refpurpose>Declares a copy-assignment operator</refpurpose>
</refnamediv>
<refsynopsisdiv>copy-assignment ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.type">type</link>?, <link linkend="api.grammar.parameter">parameter</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.type">type</link>?, <link linkend="docbook.api.parameter">parameter</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>The return type of the copy-assignment operator does not need
unqualified reference to the enclosing class type.</para>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.run-fail-test">
+ <refentry xml:id="docbook.api.run-fail-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>run-fail-test</tag></refentrytitle>
<refpurpose>A testcase that should compile and link, but fail on execution</refpurpose>
</refnamediv>
<refsynopsisdiv>run-fail-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.template">
+ <refentry xml:id="docbook.api.template">
<refmeta>
<refentrytitle>
DocBook API Element <tag>template</tag></refentrytitle>
<refpurpose>Declares the template parameters of a class or function</refpurpose>
</refnamediv>
<refsynopsisdiv>template ::=
- (<link linkend="api.grammar.template-type-parameter">template-type-parameter</link>| <link linkend="api.grammar.template-nontype-parameter">template-nontype-parameter</link>| <link linkend="api.grammar.template-varargs">template-varargs</link>)*
+ (<link linkend="docbook.api.template-type-parameter">template-type-parameter</link>| <link linkend="docbook.api.template-nontype-parameter">template-nontype-parameter</link>| <link linkend="docbook.api.template-varargs">template-varargs</link>)*
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.compile-fail-test">
+ <refentry xml:id="docbook.api.compile-fail-test">
<refmeta>
<refentrytitle>
DocBook API Element <tag>compile-fail-test</tag></refentrytitle>
<refpurpose>A testcase that should fail to compile</refpurpose>
</refnamediv>
<refsynopsisdiv>compile-fail-test ::=
- (<link linkend="api.grammar.source">source</link>*, <link linkend="api.grammar.lib">lib</link>*, <link linkend="api.grammar.requirement">requirement</link>*, <link linkend="api.grammar.purpose">purpose</link>, <link linkend="api.grammar.if-fails">if-fails</link>?)
+ (<link linkend="docbook.api.source">source</link>*, <link linkend="docbook.api.lib">lib</link>*, <link linkend="docbook.api.requirement">requirement</link>*, <link linkend="docbook.api.purpose">purpose</link>, <link linkend="docbook.api.if-fails">if-fails</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.returns">
+ <refentry xml:id="docbook.api.returns">
<refmeta>
<refentrytitle>
DocBook API Element <tag>returns</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.default">
+ <refentry xml:id="docbook.api.default">
<refmeta>
<refentrytitle>
DocBook API Element <tag>default</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.parameter">
+ <refentry xml:id="docbook.api.parameter">
<refmeta>
<refentrytitle>
DocBook API Element <tag>parameter</tag></refentrytitle>
<refpurpose>A function parameter</refpurpose>
</refnamediv>
<refsynopsisdiv>parameter ::=
- (<link linkend="api.grammar.paramtype">paramtype</link>, <link linkend="api.grammar.default">default</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.paramtype">paramtype</link>, <link linkend="docbook.api.default">default</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.signature">
+ <refentry xml:id="docbook.api.signature">
<refmeta>
<refentrytitle>
DocBook API Element <tag>signature</tag></refentrytitle>
<refpurpose>One signature of an overloaded function or method</refpurpose>
</refnamediv>
<refsynopsisdiv>signature ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.parameter">parameter</link>*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.parameter">parameter</link>*)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.overloaded-function">
+ <refentry xml:id="docbook.api.overloaded-function">
<refmeta>
<refentrytitle>
DocBook API Element <tag>overloaded-function</tag></refentrytitle>
<refpurpose>An overloaded function</refpurpose>
</refnamediv>
<refsynopsisdiv>overloaded-function ::=
- (<link linkend="api.grammar.signature">signature</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.signature">signature</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.access">
+ <refentry xml:id="docbook.api.access">
<refmeta>
<refentrytitle>
DocBook API Element <tag>access</tag></refentrytitle>
<refpurpose>Declares an access specification for class members</refpurpose>
</refnamediv>
<refsynopsisdiv>access ::=
- (<link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)+
+ (<link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)+
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element.</para>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.class">
+ <refentry xml:id="docbook.api.class">
<refmeta>
<refentrytitle>
DocBook API Element <tag>class</tag></refentrytitle>
<refpurpose>Declares a class or class template</refpurpose>
</refnamediv>
<refsynopsisdiv>class ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.inherit">inherit</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.inherit">inherit</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>C++ classes and class templates are described via the
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.librarycategorydef">
+ <refentry xml:id="docbook.api.librarycategorydef">
<refmeta>
<refentrytitle>
DocBook API Element <tag>librarycategorydef</tag></refentrytitle>
(#PCDATA)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
- <para>All library category definitions should be in <filename>doc/src/boost.xml</filename>, and the names of categories must be prefixed with "<code>category:</code>".</para>
+ <para>All library category definitions should be in the main xml file, and the names of categories must be prefixed with "<code>category:</code>".</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.type">
+ <refentry xml:id="docbook.api.type">
<refmeta>
<refentrytitle>
DocBook API Element <tag>type</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.enumvalue">
+ <refentry xml:id="docbook.api.enumvalue">
<refmeta>
<refentrytitle>
DocBook API Element <tag>enumvalue</tag></refentrytitle>
<refpurpose>A single value of an enumeration</refpurpose>
</refnamediv>
<refsynopsisdiv>enumvalue ::=
- (<link linkend="api.grammar.default">default</link>?, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.default">default</link>?, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.overloaded-method">
+ <refentry xml:id="docbook.api.overloaded-method">
<refmeta>
<refentrytitle>
DocBook API Element <tag>overloaded-method</tag></refentrytitle>
<refpurpose>An overloaded method</refpurpose>
</refnamediv>
<refsynopsisdiv>overloaded-method ::=
- (<link linkend="api.grammar.signature">signature</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, <link linkend="api.grammar.requires">requires</link>?, <link linkend="api.grammar.effects">effects</link>?, <link linkend="api.grammar.postconditions">postconditions</link>?, <link linkend="api.grammar.returns">returns</link>?, <link linkend="api.grammar.throws">throws</link>?, <link linkend="api.grammar.complexity">complexity</link>?, <link linkend="api.grammar.notes">notes</link>?, <link linkend="api.grammar.rationale">rationale</link>?)
+ (<link linkend="docbook.api.signature">signature</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, <link linkend="docbook.api.requires">requires</link>?, <link linkend="docbook.api.effects">effects</link>?, <link linkend="docbook.api.postconditions">postconditions</link>?, <link linkend="docbook.api.returns">returns</link>?, <link linkend="docbook.api.throws">throws</link>?, <link linkend="docbook.api.complexity">complexity</link>?, <link linkend="docbook.api.notes">notes</link>?, <link linkend="docbook.api.rationale">rationale</link>?)
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
<para>General documentation on functions in api is provided in
- the <link linkend="api.grammar.function"><tag>function</tag></link>
+ the <link linkend="docbook.api.function"><tag>function</tag></link>
element documentation.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.programlisting">
+ <refentry xml:id="docbook.api.programlisting">
<refmeta>
<refentrytitle>
DocBook API Element <tag>programlisting</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.complexity">
+ <refentry xml:id="docbook.api.complexity">
<refmeta>
<refentrytitle>
DocBook API Element <tag>complexity</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.purpose">
+ <refentry xml:id="docbook.api.purpose">
<refmeta>
<refentrytitle>
DocBook API Element <tag>purpose</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.template-nontype-parameter">
+ <refentry xml:id="docbook.api.template-nontype-parameter">
<refmeta>
<refentrytitle>
DocBook API Element <tag>template-nontype-parameter</tag></refentrytitle>
<refpurpose>A nontype template parameter</refpurpose>
</refnamediv>
<refsynopsisdiv>template-nontype-parameter ::=
- (<link linkend="api.grammar.type">type</link>, <link linkend="api.grammar.default">default</link>?, <link linkend="api.grammar.purpose">purpose</link>?)
+ (<link linkend="docbook.api.type">type</link>, <link linkend="docbook.api.default">default</link>?, <link linkend="docbook.api.purpose">purpose</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.library">
+ <refentry xml:id="docbook.api.library">
<refmeta>
<refentrytitle>
DocBook API Element <tag>library</tag></refentrytitle>
<refpurpose>Top-level element for a library</refpurpose>
</refnamediv>
<refsynopsisdiv>library ::=
- (<link linkend="api.grammar.libraryinfo">libraryinfo</link>, (title, ((section| <link linkend="api.grammar.library-reference">library-reference</link>| <link linkend="api.grammar.testsuite">testsuite</link>))+)?)
+ (<link linkend="docbook.api.libraryinfo">libraryinfo</link>, (title, ((section| <link linkend="docbook.api.library-reference">library-reference</link>| <link linkend="docbook.api.testsuite">testsuite</link>))+)?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.librarycategorylist">
+ <refentry xml:id="docbook.api.librarycategorylist">
<refmeta>
<refentrytitle>
DocBook API Element <tag>librarycategorylist</tag></refentrytitle>
<refpurpose>Categorized listing of libraries</refpurpose>
</refnamediv>
<refsynopsisdiv>librarycategorylist ::=
- (<link linkend="api.grammar.librarycategorydef">librarycategorydef</link>)*
+ (<link linkend="docbook.api.librarycategorydef">librarycategorydef</link>)*
</refsynopsisdiv>
<refsection><info><title>Description</title></info>
- <para>This element is not intended for use by developers, but is
- used by <filename>doc/src/boost.xml</filename> as a
+ <para>This element is used by the main XML document as a
placeholder.</para>
</refsection>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.using-namespace">
+ <refentry xml:id="docbook.api.using-namespace">
<refmeta>
<refentrytitle>
DocBook API Element <tag>using-namespace</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.enumname">
+ <refentry xml:id="docbook.api.enumname">
<refmeta>
<refentrytitle>
DocBook API Element <tag>enumname</tag></refentrytitle>
</refmeta>
<refnamediv>
<refname>enumname</refname>
- <refpurpose/>
+ <refpurpose>References an enumeration type with the given name</refpurpose>
</refnamediv>
<refsynopsisdiv>enumname ::=
(#PCDATA)
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.struct-specialization">
+ <refentry xml:id="docbook.api.struct-specialization">
<refmeta>
<refentrytitle>
DocBook API Element <tag>struct-specialization</tag></refentrytitle>
<refpurpose>A specialization (full or partial) of a struct template</refpurpose>
</refnamediv>
<refsynopsisdiv>struct-specialization ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.specialization">specialization</link>?, <link linkend="api.grammar.inherit">inherit</link>?, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.specialization">specialization</link>?, <link linkend="docbook.api.inherit">inherit</link>?, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.struct">
+ <refentry xml:id="docbook.api.struct">
<refmeta>
<refentrytitle>
DocBook API Element <tag>struct</tag></refentrytitle>
<refpurpose>Declares a C++ struct</refpurpose>
</refnamediv>
<refsynopsisdiv>struct ::=
- (<link linkend="api.grammar.template">template</link>?, <link linkend="api.grammar.inherit">inherit</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?, (<link linkend="api.grammar.access">access</link>| <link linkend="api.grammar.static-constant">static-constant</link>| <link linkend="api.grammar.typedef">typedef</link>| <link linkend="api.grammar.enum">enum</link>| <link linkend="api.grammar.copy-assignment">copy-assignment</link>| <link linkend="api.grammar.constructor">constructor</link>| <link linkend="api.grammar.destructor">destructor</link>| <link linkend="api.grammar.method-group">method-group</link>| <link linkend="api.grammar.free-function-group">free-function-group</link>| <link linkend="api.grammar.function">function</link>| <link linkend="api.grammar.method">method</link>| <link linkend="api.grammar.overloaded-function">overloaded-function</link>| <link linkend="api.grammar.overloaded-method">overloaded-method</link>| <link linkend="api.grammar.data-member">data-member</link>| <link linkend="api.grammar.class">class</link>| <link linkend="api.grammar.class-specialization">class-specialization</link>| <link linkend="api.grammar.struct">struct</link>| <link linkend="api.grammar.struct-specialization">struct-specialization</link>| <link linkend="api.grammar.union">union</link>| <link linkend="api.grammar.union-specialization">union-specialization</link>)*)
+ (<link linkend="docbook.api.template">template</link>?, <link linkend="docbook.api.inherit">inherit</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?, (<link linkend="docbook.api.access">access</link>| <link linkend="docbook.api.static-constant">static-constant</link>| <link linkend="docbook.api.typedef">typedef</link>| <link linkend="docbook.api.enum">enum</link>| <link linkend="docbook.api.copy-assignment">copy-assignment</link>| <link linkend="docbook.api.constructor">constructor</link>| <link linkend="docbook.api.destructor">destructor</link>| <link linkend="docbook.api.method-group">method-group</link>| <link linkend="docbook.api.free-function-group">free-function-group</link>| <link linkend="docbook.api.function">function</link>| <link linkend="docbook.api.method">method</link>| <link linkend="docbook.api.overloaded-function">overloaded-function</link>| <link linkend="docbook.api.overloaded-method">overloaded-method</link>| <link linkend="docbook.api.data-member">data-member</link>| <link linkend="docbook.api.class">class</link>| <link linkend="docbook.api.class-specialization">class-specialization</link>| <link linkend="docbook.api.struct">struct</link>| <link linkend="docbook.api.struct-specialization">struct-specialization</link>| <link linkend="docbook.api.union">union</link>| <link linkend="docbook.api.union-specialization">union-specialization</link>)*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.lib">
+ <refentry xml:id="docbook.api.lib">
<refmeta>
<refentrytitle>
DocBook API Element <tag>lib</tag></refentrytitle>
<para>Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile.</para>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.enum">
+ <refentry xml:id="docbook.api.enum">
<refmeta>
<refentrytitle>
DocBook API Element <tag>enum</tag></refentrytitle>
<refpurpose>Declares an enumeration type</refpurpose>
</refnamediv>
<refsynopsisdiv>enum ::=
- (<link linkend="api.grammar.enumvalue">enumvalue</link>*, <link linkend="api.grammar.purpose">purpose</link>?, <link linkend="api.grammar.description">description</link>?)
+ (<link linkend="docbook.api.enumvalue">enumvalue</link>*, <link linkend="docbook.api.purpose">purpose</link>?, <link linkend="docbook.api.description">description</link>?)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.requires">
+ <refentry xml:id="docbook.api.requires">
<refmeta>
<refentrytitle>
DocBook API Element <tag>requires</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.effects">
+ <refentry xml:id="docbook.api.effects">
<refmeta>
<refentrytitle>
DocBook API Element <tag>effects</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.libraryname">
+ <refentry xml:id="docbook.api.libraryname">
<refmeta>
<refentrytitle>
DocBook API Element <tag>libraryname</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.libraryinfo">
+ <refentry xml:id="docbook.api.libraryinfo">
<refmeta>
<refentrytitle>
DocBook API Element <tag>libraryinfo</tag></refentrytitle>
<refpurpose>Provides information about a library</refpurpose>
</refnamediv>
<refsynopsisdiv>libraryinfo ::=
- (author+, copyright*, legalnotice*, <link linkend="api.grammar.librarypurpose">librarypurpose</link>, <link linkend="api.grammar.librarycategory">librarycategory</link>*)
+ (author+, copyright*, legalnotice*, <link linkend="docbook.api.librarypurpose">librarypurpose</link>, <link linkend="docbook.api.librarycategory">librarycategory</link>*)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.testsuite">
+ <refentry xml:id="docbook.api.testsuite">
<refmeta>
<refentrytitle>
DocBook API Element <tag>testsuite</tag></refentrytitle>
<refpurpose>Describes a library testsuite</refpurpose>
</refnamediv>
<refsynopsisdiv>testsuite ::=
- ((<link linkend="api.grammar.compile-test">compile-test</link>| <link linkend="api.grammar.link-test">link-test</link>| <link linkend="api.grammar.run-test">run-test</link>| <link linkend="api.grammar.compile-fail-test">compile-fail-test</link>| <link linkend="api.grammar.link-fail-test">link-fail-test</link>| <link linkend="api.grammar.run-fail-test">run-fail-test</link>)+)
+ ((<link linkend="docbook.api.compile-test">compile-test</link>| <link linkend="docbook.api.link-test">link-test</link>| <link linkend="docbook.api.run-test">run-test</link>| <link linkend="docbook.api.compile-fail-test">compile-fail-test</link>| <link linkend="docbook.api.link-fail-test">link-fail-test</link>| <link linkend="docbook.api.run-fail-test">run-fail-test</link>)+)
</refsynopsisdiv>
<refsection><info><title>Attributes</title></info>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.header">
+ <refentry xml:id="docbook.api.header">
<refmeta>
<refentrytitle>
DocBook API Element <tag>header</tag></refentrytitle>
</informaltable>
</refsection>
</refentry>
- <refentry xml:id="api.grammar.rationale">
+ <refentry xml:id="docbook.api.rationale">
<refmeta>
<refentrytitle>
DocBook API element <tag>rationale</tag></refentrytitle>
<xsl:param name="html.stylesheet">
<xsl:choose>
- <xsl:when test = "$boost.defaults = 'Boost'">
- <xsl:value-of select = "concat($boost.root, '/boostbook.css')"/>
+ <xsl:when test = "$docbook.defaults = 'API'">
+ <xsl:value-of select = "concat($api.root, '/api.css')"/>
</xsl:when>
<xsl:otherwise>
- boostbook.css
+ api.css
</xsl:otherwise>
</xsl:choose>
</xsl:param>
- <xsl:param name="boost.graphics.root">
+ <xsl:param name="api.graphics.root">
<xsl:choose>
- <xsl:when test = "$boost.defaults = 'Boost'">
- <xsl:value-of select = "concat($boost.root, '/images/')"/>
+ <xsl:when test = "$docbook.defaults = 'API'">
+ <xsl:value-of select = "concat($api.root, '/images/')"/>
</xsl:when>
<xsl:otherwise>
<xsl:value-of select = "'images/'"/>
<xsl:param name="admon.style"/>
<xsl:param name="admon.graphics">1</xsl:param>
- <xsl:param name="boostbook.verbose" select="0"/>
+ <xsl:param name="api.verbose" select="0"/>
<xsl:param name="navig.graphics" select="1"/>
<xsl:param name="navig.graphics.extension" select="'.png'"/>
<xsl:param name="chapter.autolabel" select="1"/>
<xsl:param name="doc.standalone">false</xsl:param>
<xsl:param name="chunker.output.indent">yes</xsl:param>
<xsl:param name="chunker.output.encoding">US-ASCII</xsl:param>
- <xsl:param name="chunk.quietly" select="not(number($boostbook.verbose))"/>
+ <xsl:param name="chunk.quietly" select="not(number($api.verbose))"/>
<xsl:param name="toc.max.depth">2</xsl:param>
<xsl:param name="callout.graphics.number.limit">15</xsl:param>
- <xsl:param name = "admon.graphics.path" select="$boost.graphics.root" />
- <xsl:param name = "navig.graphics.path" select="$boost.graphics.root" />
+ <xsl:param name = "admon.graphics.path" select="$api.graphics.root" />
+ <xsl:param name = "navig.graphics.path" select="$api.graphics.root" />
<xsl:param name = "callout.graphics.path"
- select = "concat($boost.graphics.root, 'callouts/')"/>
+ select = "concat($api.graphics.root, 'callouts/')"/>
<xsl:param name="admon.style">
</xsl:template>
<!-- Footer Copyright -->
- <xsl:template match="d:copyright" mode="boost.footer">
+ <xsl:template match="d:copyright" mode="api.footer">
<xsl:if test="position() > 1">
<br/>
</xsl:if>
</xsl:template>
<!-- Footer License -->
- <xsl:template match="d:legalnotice" mode="boost.footer">
+ <xsl:template match="d:legalnotice" mode="api.footer">
<xsl:apply-templates select="d:para" mode="titlepage.mode" />
</xsl:template>
<td align="right">
<div class = "copyright-footer">
<xsl:apply-templates select="ancestor::*/*/d:copyright"
- mode="boost.footer"/>
+ mode="api.footer"/>
<xsl:apply-templates select="ancestor::*/*/d:legalnotice"
- mode="boost.footer"/>
+ mode="api.footer"/>
</div>
</td>
</tr>
<!-- <xsl:import href="relative-href.xsl"/> -->
<!--
- boost.defaults:
+ docbook.defaults:
*custom - only use explicitly set parameters
- Boost - use standard boost settings, can be overridden
+ API - use standard API extension settings, can be overridden
-->
- <xsl:param name = "boost.defaults" select = "'none'"/>
+ <xsl:param name = "docbook.defaults" select = "'none'"/>
<!--
how to render the Home | Libraries | ... | More contents
*none - do not display ("standalone" mode)
- horizontal - display in old-Boost style format (default for Boost)
+ horizontal - display in old-API style format (default for API)
vertical - like the new Getting Started layout
-->
<xsl:param name = "nav.layout">
<xsl:choose>
- <xsl:when test = "$boost.defaults='Boost'">horizontal</xsl:when>
+ <xsl:when test = "$docbook.defaults='API'">horizontal</xsl:when>
<xsl:otherwise>none</xsl:otherwise>
</xsl:choose>
</xsl:param>
<!--
header border layout
- Boost - place the old-Boost border around the header
+ API - place the old-API border around the header
*none - do not place a border around the header
-->
<xsl:param name = "nav.border" select = "'none'" />
-->
<xsl:param name = "nav.flow" select = "'Spirit'"/>
- <!-- location of the various Boost elements -->
+ <!-- location of the various DocBook API elements -->
- <xsl:param name = "boost.root" select = "'.'"/>
+ <xsl:param name = "api.root" select = "'.'"/>
<xsl:param name = "api.website" select = "'http://wiki.docbook.org/topic/BoostBookIntegration'"/>
<!-- Logo image location, leave empty for no logo -->
- <xsl:param name = "boost.image.src">
- <xsl:if test = "$boost.defaults = 'Boost'">
- <xsl:value-of select = "concat($boost.root, '/db.png')"/>
+ <xsl:param name = "api.image.src">
+ <xsl:if test = "$docbook.defaults = 'API'">
+ <xsl:value-of select = "concat($api.root, '/images/db.png')"/>
</xsl:if>
</xsl:param>
- <xsl:param name = "boost.image.alt">
- <xsl:if test = "$boost.defaults = 'Boost'">
+ <xsl:param name = "api.image.alt">
+ <xsl:if test = "$docbook.defaults = 'API'">
<xsl:value-of select = "'DocBook API Dcoumentation'"/>
</xsl:if>
</xsl:param>
- <xsl:param name = "boost.image.w">
- <xsl:if test = "$boost.defaults = 'Boost'">
+ <xsl:param name = "api.image.w">
+ <xsl:if test = "$docbook.defaults = 'API'">
<xsl:value-of select = "177"/>
</xsl:if>
</xsl:param>
- <xsl:param name = "boost.image.h">
- <xsl:if test = "$boost.defaults = 'Boost'">
+ <xsl:param name = "api.image.h">
+ <xsl:if test = "$docbook.defaults = 'API'">
<xsl:value-of select = "86"/>
</xsl:if>
</xsl:param>
-<!-- <xsl:param name = "boost.libraries">
- <xsl:if test = "$boost.defaults = 'Boost'">
- <xsl:value-of select = "concat($boost.root, '/libs/libraries.htm')"/>
+<!-- <xsl:param name = "api.libraries">
+ <xsl:if test = "$docbook.defaults = 'API'">
+ <xsl:value-of select = "concat($api.root, '/libs/libraries.htm')"/>
</xsl:if>
</xsl:param>
-->
<xsl:variable name = "up" select = "parent::*"/>
<table cellpadding = "2" width = "100%"><tr>
- <xsl:if test = "$nav.border = 'Boost'">
- <xsl:attribute name = "class">boost-head</xsl:attribute>
+ <xsl:if test = "$nav.border = 'API'">
+ <xsl:attribute name = "class">api-head</xsl:attribute>
</xsl:if>
<td valign = "top">
- <xsl:if test = "$nav.border = 'Boost'">
+ <xsl:if test = "$nav.border = 'API'">
<xsl:attribute name = "style">background-color: white; width: 50%;</xsl:attribute>
</xsl:if>
- <xsl:if test = "boolean(normalize-space($boost.image.src))">
- <img alt="{$boost.image.alt}" width="{$boost.image.w}" height="{$boost.image.h}">
+ <xsl:if test = "boolean(normalize-space($api.image.src))">
+ <img alt="{$api.image.alt}" width="{$api.image.w}" height="{$api.image.h}">
<xsl:attribute name="src">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="$boost.image.src"/>
+ <xsl:with-param name="target" select="$api.image.src"/>
</xsl:call-template>
</xsl:attribute>
</img>
<xsl:template name = "header.navdata-horiz">
<xsl:variable name="home_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.root, '/index.html' )"/>
+ <xsl:with-param name="target" select="concat( $api.root, '/index.html' )"/>
</xsl:call-template>
</xsl:variable>
<!-- <xsl:variable name="libraries_link">
- <xsl:if test = "boolean($boost.libraries)">
+ <xsl:if test = "boolean($api.libraries)">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="$boost.libraries"/>
+ <xsl:with-param name="target" select="$api.libraries"/>
</xsl:call-template>
</xsl:if>
</xsl:variable>
-->
<xsl:variable name="project_link">
- <xsl:call-template name="href.target.uri">
+ <xsl:call-template name="href.target.relative">
<xsl:with-param name="target" select="'http://wiki.docbook.org/topic/BoostBookIntegration'"/>
</xsl:call-template>
</xsl:variable>
<!-- <xsl:variable name="faq_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.website, '/users/faq.html' )"/>
+ <xsl:with-param name="target" select="concat( $api.website, '/users/faq.html' )"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="more_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.root, '/more/index.htm' )"/>
+ <xsl:with-param name="target" select="concat( $api.root, '/more/index.htm' )"/>
</xsl:call-template>
</xsl:variable>
-->
<xsl:choose>
- <xsl:when test = "$nav.border = 'Boost'">
- <td align = "center" class = "boost-headtd"><a href = "{$home_link}" class = "boost-headelem">Home</a></td>
+ <xsl:when test = "$nav.border = 'API'">
+ <td align = "center" class = "api-headtd"><a href = "{$home_link}" class = "api-headelem">Home</a></td>
<!-- <xsl:if test = "boolean($libraries_link)">
- <td align = "center" class = "boost-headtd"><a href = "{$libraries_link}" class = "boost-headelem">Libraries</a></td>
+ <td align = "center" class = "api-headtd"><a href = "{$libraries_link}" class = "api-headelem">Libraries</a></td>
</xsl:if>
-->
- <td align = "center" class = "boost-headtd"><a href = "{$project_link}" class = "boost-headelem">Project</a></td>
-<!-- <td align = "center" class = "boost-headtd"><a href = "{$faq_link}" class = "boost-headelem">FAQ</a></td>
- <td align = "center" class = "boost-headtd"><a href = "{$more_link}" class = "boost-headelem">More</a></td> -->
+ <td align = "center" class = "api-headtd"><a href = "{$project_link}" class = "api-headelem">Project</a></td>
+<!-- <td align = "center" class = "api-headtd"><a href = "{$faq_link}" class = "api-headelem">FAQ</a></td>
+ <td align = "center" class = "api-headtd"><a href = "{$more_link}" class = "api-headelem">More</a></td> -->
</xsl:when><xsl:otherwise>
<td align = "center"><a href = "{$home_link}">Home</a></td>
<!-- <td align = "center"><a href = "{$libraries_link}">Libraries</a></td> -->
<xsl:template name = "header.navdata-vert">
<xsl:variable name="home_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.root, '/index.html' )"/>
+ <xsl:with-param name="target" select="concat( $api.root, '/index.html' )"/>
</xsl:call-template>
</xsl:variable>
<!-- <xsl:variable name="libraries_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="$boost.libraries"/>
+ <xsl:with-param name="target" select="$api.libraries"/>
</xsl:call-template>
</xsl:variable>
-->
<!--
<xsl:variable name="faq_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.website, '/users/faq.html' )"/>
+ <xsl:with-param name="target" select="concat( $api.website, '/users/faq.html' )"/>
</xsl:call-template>
</xsl:variable>
<xsl:variable name="more_link">
<xsl:call-template name="href.target.relative">
- <xsl:with-param name="target" select="concat( $boost.root, '/more/index.htm' )"/>
+ <xsl:with-param name="target" select="concat( $api.root, '/more/index.htm' )"/>
</xsl:call-template>
</xsl:variable>
-->
<td><div>
- <xsl:if test = "$nav.border != 'Boost'">
- <xsl:attribute name = "class">boost-toc</xsl:attribute>
+ <xsl:if test = "$nav.border != 'API'">
+ <xsl:attribute name = "class">api-toc</xsl:attribute>
</xsl:if>
<div><a href = "{$home_link}">Home</a></div>
<!-- <div><a href = "{$libraries_link}">Libraries</a></div> -->