114 lines
5.4 KiB
HTML
114 lines
5.4 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<html>
|
||
<head>
|
||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
<title>BoostBook element library-reference</title>
|
||
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
|
||
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
||
<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
|
||
<link rel="up" href="../../reference.html" title="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%"><tr>
|
||
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
|
||
<td align="center"><a href="../../../../index.html">Home</a></td>
|
||
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
|
||
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
||
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
||
<td align="center"><a href="../../../../more/index.htm">More</a></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="librarylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
||
</div>
|
||
<div class="refentry">
|
||
<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 class="link" href="header.html" title="BoostBook element header">header</a>| <a class="link" href="library-reference.html" title="BoostBook element library-reference">library-reference</a>)*)
|
||
</div>
|
||
<div class="refsection">
|
||
<a name="id-1.4.3.7.13.4"></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 class="link" href="../../any.html" title="Chapter 4. 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 class="link" href="../../any.html" title="Chapter 4. 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">
|
||
<a name="id-1.4.3.7.13.5"></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"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0.
|
||
(See accompanying file LICENSE_1_0.txt or copy at
|
||
<a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
|
||
</p>
|
||
</div></td>
|
||
</tr></table>
|
||
<hr>
|
||
<div class="spirit-nav">
|
||
<a accesskey="p" href="librarylist.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="boostbook.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
|
||
</div>
|
||
</body>
|
||
</html>
|