| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Document Conventions</title> |
| <link rel="stylesheet" href="../math.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.77.1"> |
| <link rel="home" href="../index.html" title="Math Toolkit 2.2.0"> |
| <link rel="up" href="../overview.html" title="Chapter 1. Overview"> |
| <link rel="prev" href="navigation.html" title="Navigation"> |
| <link rel="next" href="hints.html" title="Other Hints and tips"> |
| </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="navigation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.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="hints.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| <div class="section"> |
| <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
| <a name="math_toolkit.conventions"></a><a class="link" href="conventions.html" title="Document Conventions">Document Conventions</a> |
| </h2></div></div></div> |
| <p> |
| <a class="indexterm" name="id845521"></a> |
| </p> |
| <p> |
| This documentation aims to use of the following naming and formatting conventions. |
| </p> |
| <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> |
| <li class="listitem"> |
| C++ 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, for example <code class="computeroutput"><span class="keyword">double</span></code>. |
| </li> |
| <li class="listitem"> |
| Other code is in block <code class="literal">teletype fixed-width font</code>. |
| </li> |
| <li class="listitem"> |
| Replaceable text that <span class="bold"><strong>you</strong></span> will need to |
| supply is in <em class="replaceable"><code>italics</code></em>. |
| </li> |
| <li class="listitem"> |
| If a name refers to a free function, it is specified like this: <code class="computeroutput"><span class="identifier">free_function</span><span class="special">()</span></code>; |
| that is, it is in <em class="replaceable"><code>code font</code></em> and its name is |
| followed by <code class="computeroutput"><span class="special">()</span></code> to indicate |
| that it is a free function. |
| </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 (like template parameter names) are specified in CamelCase. |
| </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"><div class="copyright-footer">Copyright © 2006-2010, 2012-2014 Nikhar Agrawal, |
| Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert |
| Holin, Bruno Lalande, John Maddock, Johan Råde, Gautam Sewani, Benjamin Sobotta, |
| Thijs van den Berg, Daryle Walker and Xiaogang Zhang<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="navigation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../overview.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="hints.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> |
| </div> |
| </body> |
| </html> |
