ceph/src/boost/libs/pool/doc/html/boost_pool/pool/conventions.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Documentation Naming and Formatting Conventions</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="../../index.html" title="Boost.Pool">
   8 <link rel="up" href="../pool.html" title="Introduction and Overview">
   9 <link rel="prev" href="../pool.html" title="Introduction and Overview">
  10 <link rel="next" href="introduction.html" title="Introduction">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="../pool.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pool.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="introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_pool.pool.conventions"></a><a class="link" href="conventions.html" title="Documentation Naming and Formatting Conventions">Documentation Naming and
  28       Formatting Conventions</a>
  29 </h3></div></div></div>
  30 <p>
  31         This documentation makes use of the following naming and formatting conventions.
  32       </p>
  33 <div class="itemizedlist"><ul class="itemizedlist" type="disc">
  34 <li class="listitem">
  35             Code is in <code class="computeroutput"><span class="identifier">fixed</span> <span class="identifier">width</span>
  36             <span class="identifier">font</span></code> and is syntax-highlighted
  37             in color.
  38           </li>
  39 <li class="listitem">
  40             Replaceable text that you will need to supply is in <em class="replaceable"><code>italics</code></em>.
  41           </li>
  42 <li class="listitem">
  43             Free functions are rendered in the <code class="computeroutput"><span class="identifier">code</span>
  44             <span class="identifier">font</span></code> followed by <code class="computeroutput"><span class="special">()</span></code>, as in <code class="computeroutput"><span class="identifier">free_function</span><span class="special">()</span></code>.
  45           </li>
  46 <li class="listitem">
  47             If a name refers to a class template, it is specified like this: <code class="computeroutput"><span class="identifier">class_template</span><span class="special">&lt;&gt;</span></code>;
  48             that is, it is in code font and its name is followed by <code class="computeroutput"><span class="special">&lt;&gt;</span></code> to indicate that it is a class
  49             template.
  50           </li>
  51 <li class="listitem">
  52             If a name refers to a function-like macro, it is specified like this:
  53             <code class="computeroutput"><span class="identifier">MACRO</span><span class="special">()</span></code>;
  54             that is, it is uppercase in code font and its name is followed by <code class="computeroutput"><span class="special">()</span></code> to indicate that it is a function-like
  55             macro. Object-like macros appear without the trailing <code class="computeroutput"><span class="special">()</span></code>.
  56           </li>
  57 <li class="listitem">
  58             Names that refer to <span class="emphasis"><em>concepts</em></span> in the generic programming
  59             sense are specified in CamelCase.
  60           </li>
  61 </ul></div>
  62 <div class="note"><table border="0" summary="Note">
  63 <tr>
  64 <td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
  65 <th align="left">Note</th>
  66 </tr>
  67 <tr><td align="left" valign="top"><p>
  68           In addition, notes such as this one specify non-essential information that
  69           provides additional background or rationale.
  70         </p></td></tr>
  71 </table></div>
  72 <p>
  73         Finally, you can mentally add the following to any code fragments in this
  74         document:
  75       </p>
  76 <pre class="programlisting"><span class="comment">// Include all of Pool files</span>
  77 <span class="preprocessor">#include</span> <span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">pool</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span>
  78 </pre>
  79 </div>
  80 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  81 <td align="left"></td>
  82 <td align="right"><div class="copyright-footer">Copyright &#169; 2000-2006 Stephen Cleary<br>Copyright &#169; 2011 Paul A. Bristow<p>
  83         Distributed under the Boost Software License, Version 1.0. (See accompanying
  84         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  85       </p>
  86 </div></td>
  87 </tr></table>
  88 <hr>
  89 <div class="spirit-nav">
  90 <a accesskey="p" href="../pool.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../pool.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="introduction.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  91 </div>
  92 </body>
  93 </html>