diff options
Diffstat (limited to 'doc/html/boostbook/introduction.html')
| -rw-r--r-- | doc/html/boostbook/introduction.html | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/html/boostbook/introduction.html b/doc/html/boostbook/introduction.html new file mode 100644 index 0000000000..c525edf8fa --- /dev/null +++ b/doc/html/boostbook/introduction.html @@ -0,0 +1,85 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<title>Chapter 16. Introduction</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="../boostbook.html" title="Part II. The BoostBook Documentation Format"> +<link rel="prev" href="../boostbook.html" title="Part II. The BoostBook Documentation Format"> +<link rel="next" href="getting/started.html" title="Chapter 17. Getting Started"> +</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="../boostbook.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.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="getting/started.html"><img src="../images/next.png" alt="Next"></a> +</div> +<div class="chapter" lang="en"> +<div class="titlepage"><div><div><h2 class="title"> +<a name="boostbook.introduction"></a>Chapter 16. Introduction</h2></div></div></div> +<p>The BoostBook documentation format is an extension of <a href="http://www.docbook.org" target="_top">DocBook</a>, an SGML- or + XML-based format for describing documentation. BoostBook augments + DocBook with semantic markup that aids in the documentation of C++ + libraries, specifically the <a href="http://www.boost.org" target="_top">Boost C++ libraries</a>, by + providing the ability to express and refer to C++ constructs such + as namespaces, classes, overloaded functions, templates, and + specializations.</p> +<p> + BoostBook offers additional features more specific to its use for + documenting the <a href="http://www.boost.org" target="_top">Boost C++ + libraries</a>. These features are intended to eliminate or + reduce the need for duplication of information and to aid in + documenting portions of Boost that might otherwise not be + documented. Examples of Boost-centric features include: + </p> +<div class="itemizedlist"><ul type="disc"> +<li><p><span class="bold"><strong>Testsuites</strong></span>: + Testsuites in Boost are created by writing an appropriate + Jamfile and including that Jamfile in + <code class="filename">status/Jamfile</code>. If the testsuites are + documented (<a href="http://www.boost.org/libs/multi_array/doc/test_cases.html" target="_top">as + in the MultiArray library</a>), the documentation is + maintained separately from the testcase Jamfile, leading to + duplication of information and the possibility of having the + documentation out of sync with the Jamfile. BoostBook + contains elements that describe a testsuite for both + purposes: the BoostBook stylesheets can generate + documentation for the testcases and also generate an + appropriate Jamfile to integrate the testcases with the + regression testing system.</p></li> +<li> +<p><span class="bold"><strong>Example programs</strong></span>: + Example programs in documentation need to be duplicated in + testcases to ensure that the examples compile and execute + correctly. Keeping the two copies in sync is a tedious and + error-prone task. For instance, the following code snippet + persisted for six months:</p> +<pre class="programlisting"> +std::cout << f(5, 3) >> std::endl; +</pre> +<p>The BoostBook format allows testcases to be generated + by weaving together program fragments from example programs + in the documentation. This capability is integrated with + testsuite generation so that example programs are normal + tests in BoostBook.</p> +</li> +</ul></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="../boostbook.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../boostbook.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="getting/started.html"><img src="../images/next.png" alt="Next"></a> +</div> +</body> +</html> |