1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>BoostBook element library-reference</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../reference.html" title="Reference"> 10<link rel="prev" href="librarylist.html" title="BoostBook element librarylist"> 11<link rel="next" href="boostbook.html" title="BoostBook element boostbook"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boostbook.dtd.library-reference"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle"> 30 BoostBook element <code class="sgmltag-element">library-reference</code></span></h2> 31<p>library-reference — Declares the reference material for a library</p> 32</div> 33<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 34<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">library-reference ::= 35 (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>)*) 36</div> 37<div class="refsection"> 38<a name="id-1.4.3.7.13.4"></a><h2>Description</h2> 39<p>Reference documentation for a library is contained with a 40 <library-reference> element. The <library-reference> 41 element has no attributes, and contains as children only 42 <header> elements.</p> 43<p>The <header> element defines a C++ header file. Within 44 each C++ header file lie the definitions of C++ constructs to be 45 documented. The <code class="computeroutput">name</code> attribute of the <header> 46 element gives the name of the header, as one would specify when 47 including the header. For instance, the <library-reference> 48 for the <a class="link" href="../../any.html" title="Chapter 4. Boost.Any">Any</a> library may look like 49 this:</p> 50<pre class="programlisting"><library-reference> 51 <header name="boost/any.hpp"> 52 <!-- C++ constructs in this header --> 53 </header> 54</library-reference></pre> 55<p>If the <a class="link" href="../../any.html" title="Chapter 4. Boost.Any">Any</a> library contained 56 multiple headers, we would list them all as children of the 57 <library-reference> element.</p> 58<p><code class="sgmltag-element">library-reference</code> elements can be nested, 59 so that reference material can be divided into separate sections 60 that each contain different headers.</p> 61</div> 62<div class="refsection"> 63<a name="id-1.4.3.7.13.5"></a><h2>Attributes</h2> 64<div class="informaltable"><table class="table"> 65<colgroup> 66<col> 67<col> 68<col> 69<col> 70</colgroup> 71<thead><tr> 72<th>Name</th> 73<th>Type</th> 74<th>Value</th> 75<th>Purpose</th> 76</tr></thead> 77<tbody> 78<tr> 79<td>last-revision</td> 80<td>#IMPLIED</td> 81<td>CDATA</td> 82<td>Set to $Date$ to keep "last revised" information in sync with CVS changes</td> 83</tr> 84<tr> 85<td>id</td> 86<td>#IMPLIED</td> 87<td>CDATA</td> 88<td>A global identifier for this element</td> 89</tr> 90<tr> 91<td>xml:base</td> 92<td>#IMPLIED</td> 93<td>CDATA</td> 94<td>Implementation detail used by XIncludes</td> 95</tr> 96</tbody> 97</table></div> 98</div> 99</div> 100<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 101<td align="left"></td> 102<td align="right"><div class="copyright-footer">Copyright © 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0. 103 (See accompanying file LICENSE_1_0.txt or copy at 104 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>). 105 </p> 106</div></td> 107</tr></table> 108<hr> 109<div class="spirit-nav"> 110<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> 111</div> 112</body> 113</html> 114
