diff options
Diffstat (limited to 'doc/html/boostbook/dtd/library-reference.html')
| -rw-r--r-- | doc/html/boostbook/dtd/library-reference.html | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/doc/html/boostbook/dtd/library-reference.html b/doc/html/boostbook/dtd/library-reference.html new file mode 100644 index 0000000000..5d797c9df5 --- /dev/null +++ b/doc/html/boostbook/dtd/library-reference.html @@ -0,0 +1,113 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title> + BoostBook element library-reference</title> +<link rel="stylesheet" href="../../boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.68.1"> +<link rel="start" href="../../index.html" title="The Boost C++ Libraries"> +<link rel="up" href="../../reference.html" title="Chapter 20. Reference"> +<link rel="prev" href="librarylist.html" title=" + BoostBook element librarylist"> +<link rel="next" href="boostbook.html" title=" + BoostBook element boostbook"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"> +<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.htm">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="../../../../people/people.htm">People</a></td> +<td align="center"><a href="../../../../more/faq.htm">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../images/next.png" alt="Next"></a> +</div> +<div class="refentry" lang="en"> +<a name="boostbook.dtd.library-reference"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle"> + BoostBook element <code class="sgmltag-element">library-reference</code></span></h2> +<p>library-reference — Declares the reference material for a library</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">library-reference ::= + (title?, section*, (<a href="header.html" title=" + BoostBook element header">header</a>| <a href="library-reference.html" title=" + BoostBook element library-reference">library-reference</a>)*) +</div> +<div class="refsection" lang="en"> +<a name="id1676182"></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="computeroutput">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 <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> 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 <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> 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" lang="en"> +<a name="id1676246"></a><h2>Attributes</h2> +<div class="informaltable"><table class="table"> +<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$ 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 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="librarylist.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../images/next.png" alt="Next"></a> +</div> +</body> +</html> |