94 lines
6.0 KiB
HTML
94 lines
6.0 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>Documentation Naming and Formatting Conventions</title>
|
|
<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
<link rel="home" href="../../index.html" title="Boost.Pool">
|
|
<link rel="up" href="../pool.html" title="Introduction and Overview">
|
|
<link rel="prev" href="../pool.html" title="Introduction and Overview">
|
|
<link rel="next" href="introduction.html" title="Introduction">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr>
|
|
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
|
|
<td align="center"><a href="../../../../../../index.html">Home</a></td>
|
|
<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
|
|
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
|
|
<td align="center"><a href="../../../../../../more/index.htm">More</a></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<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>
|
|
</div>
|
|
<div class="section">
|
|
<div class="titlepage"><div><div><h3 class="title">
|
|
<a name="boost_pool.pool.conventions"></a><a class="link" href="conventions.html" title="Documentation Naming and Formatting Conventions">Documentation Naming and
|
|
Formatting Conventions</a>
|
|
</h3></div></div></div>
|
|
<p>
|
|
This documentation makes use of the following naming and formatting conventions.
|
|
</p>
|
|
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
|
|
<li class="listitem">
|
|
Code is in <code class="computeroutput"><span class="identifier">fixed</span> <span class="identifier">width</span>
|
|
<span class="identifier">font</span></code> and is syntax-highlighted
|
|
in color.
|
|
</li>
|
|
<li class="listitem">
|
|
Replaceable text that you will need to supply is in <em class="replaceable"><code>italics</code></em>.
|
|
</li>
|
|
<li class="listitem">
|
|
Free functions are rendered in the <code class="computeroutput"><span class="identifier">code</span>
|
|
<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>.
|
|
</li>
|
|
<li class="listitem">
|
|
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"><></span></code>;
|
|
that is, it is in code font and its name is followed by <code class="computeroutput"><span class="special"><></span></code> to indicate that it is a class
|
|
template.
|
|
</li>
|
|
<li class="listitem">
|
|
If a name refers to a function-like macro, it is specified like this:
|
|
<code class="computeroutput"><span class="identifier">MACRO</span><span class="special">()</span></code>;
|
|
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
|
|
macro. Object-like macros appear without the trailing <code class="computeroutput"><span class="special">()</span></code>.
|
|
</li>
|
|
<li class="listitem">
|
|
Names that refer to <span class="emphasis"><em>concepts</em></span> in the generic programming
|
|
sense are specified in CamelCase.
|
|
</li>
|
|
</ul></div>
|
|
<div class="note"><table border="0" summary="Note">
|
|
<tr>
|
|
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../doc/src/images/note.png"></td>
|
|
<th align="left">Note</th>
|
|
</tr>
|
|
<tr><td align="left" valign="top"><p>
|
|
In addition, notes such as this one specify non-essential information that
|
|
provides additional background or rationale.
|
|
</p></td></tr>
|
|
</table></div>
|
|
<p>
|
|
Finally, you can mentally add the following to any code fragments in this
|
|
document:
|
|
</p>
|
|
<pre class="programlisting"><span class="comment">// Include all of Pool files</span>
|
|
<span class="preprocessor">#include</span> <span class="special"><</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">></span>
|
|
</pre>
|
|
</div>
|
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
|
<td align="left"></td>
|
|
<td align="right"><div class="copyright-footer">Copyright © 2000-2006 Stephen Cleary<br>Copyright © 2011 Paul A. Bristow<p>
|
|
Distributed under the Boost Software License, Version 1.0. (See accompanying
|
|
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>)
|
|
</p>
|
|
</div></td>
|
|
</tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<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>
|
|
</div>
|
|
</body>
|
|
</html>
|