صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
samien
/
boost
mirrorاز https://github.com/boostorg/boost
1
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 923aa9c46d
شاخه‌ها تگ‌ها
boost
/
doc
/
html
/
boostbook.html

boostbook.html 21 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120 
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The BoostBook Documentation Format</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.61.3"><link rel="home" href="index.html" title="The Boost C++ Libraries"><link rel="up" href="index.html" title="The Boost C++ Libraries"><link rel="previous" href="variant.refs.html" title="References"><link rel="next" href="boostbook.getting.started.html" title="Getting Started"><link rel="chapter" href="libraries.html" title="The Boost C++ Libraries"><link rel="chapter" href="any.html" title="Boost.Any"><link rel="refentry" href="class.boost.bad_any_cast.html" title="Class bad_any_cast"><link rel="refentry" href="class.boost.any.html" title="Class any"><link rel="refentry" href="id2383300-bb.html" title="Function any_cast"><link rel="chapter" href="array.html" title="Boost.Array"><link rel="refentry" href="class.boost.array.html" title="Class template array"><link rel="chapter" href="function.html" title="Boost.Function"><link rel="refentry" href="class.boost.bad_function_call.html" title="Class bad_function_call"><link rel="refentry" href="class.boost.function_base.html" title="Class function_base"><link rel="refentry" href="class.boost.functionN.html" title="Class template functionN"><link rel="refentry" href="class.boost.function.html" title="Class template function"><link rel="chapter" href="ref.html" title="Boost.Ref"><link rel="refentry" href="class.boost.reference_wrapper.html" title="Class template reference_wrapper"><link rel="refentry" href="class.boost.is_reference_wrapper.html" title="Class template is_reference_wrapper"><link rel="refentry" href="class.boost.unwrap_reference.html" title="Class template unwrap_reference"><link rel="chapter" href="signals.html" title="Boost.Signals"><link rel="refentry" href="class.boost.signalN.html" title="Class template signalN"><link rel="refentry" href="class.boost.signal.html" title="Class template signal"><link rel="refentry" href="class.boost.slot.html" title="Class template slot"><link rel="refentry" href="class.boost.signals.trackable.html" title="Class trackable"><link rel="refentry" href="class.boost.signals.connection.html" title="Class connection"><link rel="refentry" href="class.boost.signals.scoped_connection.html" title="Class scoped_connection"><link rel="refentry" href="id2532119-bb.html" title="Function template visit_each"><link rel="refentry" href="class.boost.last_value.html" title="Class template last_value"><link rel="refentry" href="id2354683-bb.html" title="Class last_value&lt;void&gt;"><link rel="chapter" href="variant.html" title="Boost.Variant"><link rel="refentry" href="BOOST_VARIANT_LIMIT_TYPES.html" title="Macro BOOST_VARIANT_LIMIT_TYPES"><link rel="refentry" href="BOOST_VARIANT_ENUM_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_PARAMS"><link rel="refentry" href="BOOST_VARIANT_ENUM_SHIFTED_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_SHIFTED_PARAMS"><link rel="refentry" href="BOOST_VARIANT_NO_REFERENCE_SUPPORT.html" title="Macro BOOST_VARIANT_NO_REFERENCE_SUPPORT"><link rel="refentry" href="BOOST_VARIANT_NO_TYPE_SEQUENCE_SUPPORT.html" title="Macro BOOST_VARIANT_NO_TYPE_SEQUENCE_SUPPORT"><link rel="refentry" href="BOOST_VARIANT_NO_FULL_RECURSIVE_VARIANT_SUPPORT.html" title="Macro BOOST_VARIANT_NO_FULL_RECURSIVE_VARIANT_SUPPORT"><link rel="refentry" href="class.boost.variant.html" title="Class template variant"><link rel="refentry" href="id2518553-bb.html" title="Function template swap"><link rel="refentry" href="id2524211-bb.html" title="Function template operator&lt;&lt;"><link rel="refentry" href="class.boost.make_variant_over.html" title="Class template make_variant_over"><link rel="refentry" href="class.boost.make_recursive_variant.html" title="Class template make_recursive_variant"><link rel="refentry" href="class.boost.make_recursive_variant_over.html" title="Class template make_recursive_variant_over"><link rel="refentry" href="class.boost.recursive_wrapper.html" title="Class template recursive_wrapper"><link rel="refentry" href="class.boost.is_recursive_wrapper.html" title="Class template is_recursive_wrapper"><link rel="refentry" href="class.boost.unwrap_recursive_wrapper.html" title="Class template unwrap_recursive_wrapper"><link rel="refentry" href="class.boost.apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t"><link rel="refentry" href="id2557051-bb.html" title="Function apply_visitor"><link rel="refentry" href="class.boost.bad_get.html" title="Class bad_get"><link rel="refentry" href="id2493238-bb.html" title="Function get"><link rel="refentry" href="class.boost.bad_visit.html" title="Class bad_visit"><link rel="refentry" href="class.boost.static_visitor.html" title="Class template static_visitor"><link rel="refentry" href="class.boost.visitor_ptr_t.html" title="Class template visitor_ptr_t"><link rel="refentry" href="id2544445-bb.html" title="Function template visitor_ptr"><link rel="chapter" href="boostbook.html" title="The BoostBook Documentation Format"><link rel="refentry" href="boostbook.dtd.class-specialization.html" title="
    2. 

  2.           BoostBook element class-specialization"><link rel="refentry" href="boostbook.dtd.link-test.html" title="
    3. 

  3.           BoostBook element link-test"><link rel="refentry" href="boostbook.dtd.link-fail-test.html" title="
    4. 

  4.           BoostBook element link-fail-test"><link rel="refentry" href="boostbook.dtd.typedef.html" title="
    5. 

  5.           BoostBook element typedef"><link rel="refentry" href="boostbook.dtd.static-constant.html" title="
    6. 

  6.           BoostBook element static-constant"><link rel="refentry" href="boostbook.dtd.code.html" title="
    7. 

  7.           BoostBook element code"><link rel="refentry" href="boostbook.dtd.destructor.html" title="
    8. 

  8.           BoostBook element destructor"><link rel="refentry" href="boostbook.dtd.template-type-parameter.html" title="
    9. 

  9.           BoostBook element template-type-parameter"><link rel="refentry" href="boostbook.dtd.description.html" title="
    10. 

  10.           BoostBook element description"><link rel="refentry" href="boostbook.dtd.librarylist.html" title="
    11. 

  11.           BoostBook element librarylist"><link rel="refentry" href="boostbook.dtd.library-reference.html" title="
    12. 

  12.           BoostBook element library-reference"><link rel="refentry" href="boostbook.dtd.boostbook.html" title="
    13. 

  13.           BoostBook element boostbook"><link rel="refentry" href="boostbook.dtd.union.html" title="
    14. 

  14.           BoostBook element union"><link rel="refentry" href="boostbook.dtd.inherit.html" title="
    15. 

  15.           BoostBook element inherit"><link rel="refentry" href="boostbook.dtd.template-varargs.html" title="
    16. 

  16.           BoostBook element template-varargs"><link rel="refentry" href="boostbook.dtd.source.html" title="
    17. 

  17.           BoostBook element source"><link rel="refentry" href="boostbook.dtd.function.html" title="
    18. 

  18.           BoostBook element function"><link rel="refentry" href="boostbook.dtd.postconditions.html" title="
    19. 

  19.           BoostBook element postconditions"><link rel="refentry" href="boostbook.dtd.compile-test.html" title="
    20. 

  20.           BoostBook element compile-test"><link rel="refentry" href="boostbook.dtd.method.html" title="
    21. 

  21.           BoostBook element method"><link rel="refentry" href="boostbook.dtd.snippet.html" title="
    22. 

  22.           BoostBook element snippet"><link rel="refentry" href="boostbook.dtd.constructor.html" title="
    23. 

  23.           BoostBook element constructor"><link rel="refentry" href="boostbook.dtd.namespace.html" title="
    24. 

  24.           BoostBook element namespace"><link rel="refentry" href="boostbook.dtd.if-fails.html" title="
    25. 

  25.           BoostBook element if-fails"><link rel="refentry" href="boostbook.dtd.free-function-group.html" title="
    26. 

  26.           BoostBook element free-function-group"><link rel="refentry" href="boostbook.dtd.functionname.html" title="
    27. 

  27.           BoostBook element functionname"><link rel="refentry" href="boostbook.dtd.librarycategory.html" title="
    28. 

  28.           BoostBook element librarycategory"><link rel="refentry" href="boostbook.dtd.notes.html" title="
    29. 

  29.           BoostBook element notes"><link rel="refentry" href="boostbook.dtd.data-member.html" title="
    30. 

  30.           BoostBook element data-member"><link rel="refentry" href="boostbook.dtd.specialization.html" title="
    31. 

  31.           BoostBook element specialization"><link rel="refentry" href="boostbook.dtd.union-specialization.html" title="
    32. 

  32.           BoostBook element union-specialization"><link rel="refentry" href="boostbook.dtd.throws.html" title="
    33. 

  33.           BoostBook element throws"><link rel="refentry" href="boostbook.dtd.template-arg.html" title="
    34. 

  34.           BoostBook element template-arg"><link rel="refentry" href="boostbook.dtd.method-group.html" title="
    35. 

  35.           BoostBook element method-group"><link rel="refentry" href="boostbook.dtd.requirement.html" title="
    36. 

  36.           BoostBook element requirement"><link rel="refentry" href="boostbook.dtd.precondition.html" title="
    37. 

  37.           BoostBook element precondition"><link rel="refentry" href="boostbook.dtd.paramtype.html" title="
    38. 

  38.           BoostBook element paramtype"><link rel="refentry" href="boostbook.dtd.using-class.html" title="
    39. 

  39.           BoostBook element using-class"><link rel="refentry" href="boostbook.dtd.run-test.html" title="
    40. 

  40.           BoostBook element run-test"><link rel="refentry" href="boostbook.dtd.librarypurpose.html" title="
    41. 

  41.           BoostBook element librarypurpose"><link rel="refentry" href="boostbook.dtd.copy-assignment.html" title="
    42. 

  42.           BoostBook element copy-assignment"><link rel="refentry" href="boostbook.dtd.run-fail-test.html" title="
    43. 

  43.           BoostBook element run-fail-test"><link rel="refentry" href="boostbook.dtd.template.html" title="
    44. 

  44.           BoostBook element template"><link rel="refentry" href="boostbook.dtd.compile-fail-test.html" title="
    45. 

  45.           BoostBook element compile-fail-test"><link rel="refentry" href="boostbook.dtd.returns.html" title="
    46. 

  46.           BoostBook element returns"><link rel="refentry" href="boostbook.dtd.default.html" title="
    47. 

  47.           BoostBook element default"><link rel="refentry" href="boostbook.dtd.parameter.html" title="
    48. 

  48.           BoostBook element parameter"><link rel="refentry" href="boostbook.dtd.signature.html" title="
    49. 

  49.           BoostBook element signature"><link rel="refentry" href="boostbook.dtd.overloaded-function.html" title="
    50. 

  50.           BoostBook element overloaded-function"><link rel="refentry" href="boostbook.dtd.class.html" title="
    51. 

  51.           BoostBook element class"><link rel="refentry" href="boostbook.dtd.librarycategorydef.html" title="
    52. 

  52.           BoostBook element librarycategorydef"><link rel="refentry" href="boostbook.dtd.type.html" title="
    53. 

  53.           BoostBook element type"><link rel="refentry" href="boostbook.dtd.enumvalue.html" title="
    54. 

  54.           BoostBook element enumvalue"><link rel="refentry" href="boostbook.dtd.overloaded-method.html" title="
    55. 

  55.           BoostBook element overloaded-method"><link rel="refentry" href="boostbook.dtd.programlisting.html" title="
    56. 

  56.           BoostBook element programlisting"><link rel="refentry" href="boostbook.dtd.complexity.html" title="
    57. 

  57.           BoostBook element complexity"><link rel="refentry" href="boostbook.dtd.purpose.html" title="
    58. 

  58.           BoostBook element purpose"><link rel="refentry" href="boostbook.dtd.template-nontype-parameter.html" title="
    59. 

  59.           BoostBook element template-nontype-parameter"><link rel="refentry" href="boostbook.dtd.library.html" title="
    60. 

  60.           BoostBook element library"><link rel="refentry" href="boostbook.dtd.librarycategorylist.html" title="
    61. 

  61.           BoostBook element librarycategorylist"><link rel="refentry" href="boostbook.dtd.using-namespace.html" title="
    62. 

  62.           BoostBook element using-namespace"><link rel="refentry" href="boostbook.dtd.struct-specialization.html" title="
    63. 

  63.           BoostBook element struct-specialization"><link rel="refentry" href="boostbook.dtd.struct.html" title="
    64. 

  64.           BoostBook element struct"><link rel="refentry" href="boostbook.dtd.lib.html" title="
    65. 

  65.           BoostBook element lib"><link rel="refentry" href="boostbook.dtd.enum.html" title="
    66. 

  66.           BoostBook element enum"><link rel="refentry" href="boostbook.dtd.requires.html" title="
    67. 

  67.           BoostBook element requires"><link rel="refentry" href="boostbook.dtd.effects.html" title="
    68. 

  68.           BoostBook element effects"><link rel="refentry" href="boostbook.dtd.libraryname.html" title="
    69. 

  69.           BoostBook element libraryname"><link rel="refentry" href="boostbook.dtd.libraryinfo.html" title="
    70. 

  70.           BoostBook element libraryinfo"><link rel="refentry" href="boostbook.dtd.testsuite.html" title="
    71. 

  71.           BoostBook element testsuite"><link rel="refentry" href="boostbook.dtd.header.html" title="
    72. 

  72.           BoostBook element header"><link rel="refentry" href="boostbook.dtd.rationale.html" title="
    73. 

  73.           BoostBook element rationale"><link rel="refentry" href="Assignable.html" title="Concept Assignable"><link rel="refentry" href="InputIterator.html" title="Concept InputIterator"><link rel="refentry" href="OutputIterator.html" title="Concept OutputIterator"><link rel="refentry" href="ForwardIterator.html" title="Concept ForwardIterator"><link rel="refentry" href="BidirectionalIterator.html" title="Concept BidirectionalIterator"><link rel="refentry" href="RandomAccessIterator.html" title="Concept RandomAccessIterator"><link rel="refentry" href="DefaultConstructible.html" title="Concept DefaultConstructible"><link rel="refentry" href="CopyConstructible.html" title="Concept CopyConstructible"><link rel="refentry" href="EqualityComparable.html" title="Concept EqualityComparable"><link rel="refentry" href="LessThanComparable.html" title="Concept LessThanComparable"><link rel="refentry" href="SignedInteger.html" title="Concept SignedInteger"><link rel="section" href="boostbook.html#id2539975" title="Introduction"><link rel="section" href="boostbook.getting.started.html" title="Getting Started"><link rel="section" href="boostbook.documenting.html" title="Documenting libraries"><link rel="section" href="boostbook.together.html" title="Bringing Together a BoostBook Document"><link rel="section" href="reference.html" title="Reference"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" border="1" cellpadding="2" bgcolor="#007F7F"><tr><td bgcolor="#FFFFFF"><img src="../../c++boost.gif" alt="c++boost.gif (8819 bytes)" width="277" height="86"></td><td><a href="../../index.htm"><font color="#FFFFFF" size="4" face="Arial">Home</font></a></td><td><a href="libraries.html"><font color="#FFFFFF" size="4" face="Arial">Libraries</font></a></td><td><a href="../../people/people.htm"><font color="#FFFFFF" size="4" face="Arial">People</font></a></td><td><a href="../../more/faq.htm"><font color="#FFFFFF" size="4" face="Arial">FAQ</font></a></td><td><a href="../../more/index.htm"><font color="#FFFFFF" size="4" face="Arial">More</font></a></td></tr></table><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="boostbook"></a>The BoostBook Documentation Format</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Douglas</span> <span class="surname">Gregor</span></h3></div></div><div><p class="copyright">Copyright © 2003 Douglas Gregor</p></div><div><div class="legalnotice"><p>Permission to copy, use, sell and distribute this software
    74. 

  74.       is granted provided this copyright notice appears in all copies.
    75. 

  75.       Permission to modify the code and to distribute modified code is
    76. 

  76.       granted provided this copyright notice appears in all copies,
    77. 

  77.       and a notice that the code was modified is included with the
    78. 

  78.       copyright notice. </p><p> This software is provided "as is" without express or
    79. 

  79.       implied warranty, and with no claim as to its suitability for
    80. 

  80.       any purpose. </p></div></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="boostbook.html#id2539975">Introduction</a></dt><dt><a href="boostbook.getting.started.html">Getting Started</a></dt><dd><dl><dt><a href="boostbook.getting.started.html#boostbook.docbook.config">Configuring local DocBook XSL and DTD distributions</a></dt><dt><a href="boostbook.getting.started.html#boostbook.fop">Configuring Apache FOP for PostScript/PDF Output</a></dt><dt><a href="boostbook.getting.started.html#boostbook.doxygen">Configuring Doxygen for Documentation Extraction</a></dt></dl></dd><dt><a href="boostbook.documenting.html">Documenting libraries</a></dt><dd><dl><dt><a href="boostbook.documenting.html#boostbook.defining">Defining a BoostBook library</a></dt><dt><a href="boostbook.documenting.html#id2541037">From HTML to BoostBook</a></dt><dt><a href="boostbook.documenting.html#boostbook.sectioning">Sectioning in BoostBook</a></dt></dl></dd><dt><a href="boostbook.together.html">Bringing Together a BoostBook Document</a></dt><dd><dl><dt><a href="boostbook.together.html#boostbook.linking">Linking in BoostBook</a></dt></dl></dd><dt><a href="reference.html">Reference</a></dt></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2539975"></a>Introduction</h3></div></div><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
    81. 

  81.     XML-based format for describing documentation. BoostBook augments
    82. 

  82.     DocBook with semantic markup that aids in the documentation of C++
    83. 

  83.     libraries, specifically the <a href="http://www.boost.org" target="_top">Boost C++ libraries</a>, by
    84. 

  84.     providing the ability to express and refer to C++ constructs such
    85. 

  85.     as namespaces, classes, overloaded functions, templates, and
    86. 

  86.     specializations.</p><p>
    87. 

  87.     BoostBook offers additional features more specific to its use for
    88. 

  88.     documenting the <a href="http://www.boost.org" target="_top">Boost C++
    89. 

  89.     libraries</a>. These features are intended to eliminate or
    90. 

  90.     reduce the need for duplication of information and to aid in
    91. 

  91.     documenting portions of Boost that might otherwise not be
    92. 

  92.     documented. Examples of Boost-centric features include:
    93. 

  93.       </p><div class="itemizedlist"><ul type="disc"><li><p><span class="bold"><b>Testsuites</b></span>:
    94. 

  94.           Testsuites in Boost are created by writing an appropriate
    95. 

  95.           Jamfile and including that Jamfile in
    96. 

  96.           <tt class="filename">status/Jamfile</tt>. If the testsuites are
    97. 

  97.           documented (<a href="http://www.boost.org/libs/multi_array/doc/test_cases.html" target="_top">as
    98. 

  98.           in the MultiArray library</a>), the documentation is
    99. 

  99.           maintained separately from the testcase Jamfile, leading to
    100. 

  100.           duplication of information and the possibility of having the
    101. 

  101.           documentation out of sync with the Jamfile. BoostBook
    102. 

  102.           contains elements that describe a testsuite for both
    103. 

  103.           purposes: the BoostBook stylesheets can generate
    104. 

  104.           documentation for the testcases and also generate an
    105. 

  105.           appropriate Jamfile to integrate the testcases with the
    106. 

  106.           regression testing system.</p></li><li><p><span class="bold"><b>Example programs</b></span>:
    107. 

  107.           Example programs in documentation need to be duplicated in
    108. 

  108.           testcases to ensure that the examples compile and execute
    109. 

  109.           correctly. Keeping the two copies in sync is a tedious and
    110. 

  110.           error-prone task. For instance, the following code snippet
    111. 

  111.           persisted for six months:</p><pre class="programlisting">
    112. 

  112. std::cout &lt;&lt; f(5, 3) &gt;&gt; std::endl;
    113. 

  113. </pre><p>The BoostBook format allows testcases to be generated
    114. 

  114.           by weaving together program fragments from example programs
    115. 

  115.           in the documentation. This capability is integrated with
    116. 

  116.           testsuite generation so that example programs are normal
    117. 

  117.           tests in BoostBook.</p></li><li><p><span class="bold"><b>Library
    118. 

  118.           categorization</b></span>: BoostBook contains primitives for
    119. 

  119.           placing libraries into categories and generating categorized
    120. 

  120.           and alphabetized lists of libraries.</p></li></ul></div></div></div><table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr><td align="left"><small>Last revised:  ,  at  GMT</small></td><td align="right"><small></small></td></tr></table><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="variant.refs.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="boostbook.getting.started.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">References </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> Getting Started</td></tr></table></div></body></html>
    121.
粤ICP备19079148号