Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/boostbook/dtd/library-reference.html @ 29

Last change on this file since 29 was 29, checked in by landauf, 17 years ago

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