Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_33_1/doc/html/boostbook/dtd/library-reference.html @ 12

Last change on this file since 12 was 12, checked in by landauf, 18 years ago

added boost
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.69.1">
8<link rel="start" href="../../index.html" title="The Boost C++ Libraries">
9<link rel="up" href="../../reference.html" title="Chapter 20. 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.png (6897 bytes)" 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="id2846032"></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<p>The &lt;header&gt; element defines a C++ header file. Within
48  each C++ header file lie the definitions of C++ constructs to be
49  documented. The <code class="computeroutput">name</code> attribute of the &lt;header&gt;
50  element gives the name of the header, as one would specify when
51  including the header. For instance, the &lt;library-reference&gt;
52  for the <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> library may look like
53  this:</p>
54<pre class="programlisting">&lt;library-reference&gt;
55  &lt;header name="boost/any.hpp"&gt;
56    &lt;!-- C++ constructs in this header --&gt;
57  &lt;/header&gt;
58&lt;/library-reference&gt;</pre>
59<p>If the <a href="../../any.html" title="Chapter 1. Boost.Any">Any</a> library contained
60  multiple headers, we would list them all as children of the
61  &lt;library-reference&gt; element.</p>
62<p><code class="sgmltag-element">library-reference</code> elements can be nested,
63  so that reference material can be divided into separate sections
64  that each contain different headers.</p>
65</div>
66<div class="refsection" lang="en">
67<a name="id2846094"></a><h2>Attributes</h2>
68<div class="informaltable"><table class="table">
69<colgroup>
70<col>
71<col>
72<col>
73<col>
74</colgroup>
75<thead><tr>
76<th>Name</th>
77<th>Type</th>
78<th>Value</th>
79<th>Purpose</th>
80</tr></thead>
81<tbody>
82<tr>
83<td>last-revision</td>
84<td>#IMPLIED</td>
85<td>CDATA</td>
86<td>Set to $Date: 2005/12/04 17:26:48 $ to keep "last revised" information in sync with CVS changes</td>
87</tr>
88<tr>
89<td>id</td>
90<td>#IMPLIED</td>
91<td>CDATA</td>
92<td>A global identifier for this element</td>
93</tr>
94<tr>
95<td>xml:base</td>
96<td>#IMPLIED</td>
97<td>CDATA</td>
98<td>Implementation detail used by XIncludes</td>
99</tr>
100</tbody>
101</table></div>
102</div>
103</div>
104<table width="100%"><tr>
105<td align="left"></td>
106<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td>
107</tr></table>
108<hr>
109<div class="spirit-nav">
110<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>
111</div>
112</body>
113</html>
Note: See TracBrowser for help on using the repository browser.