3 <meta http-equiv=
"Content-Type" content=
"text/html; charset=US-ASCII">
4 <title>Document Conventions
</title>
5 <link rel=
"stylesheet" href=
"../math.css" type=
"text/css">
6 <meta name=
"generator" content=
"DocBook XSL Stylesheets V1.77.1">
7 <link rel=
"home" href=
"../index.html" title=
"Math Toolkit 2.5.1">
8 <link rel=
"up" href=
"../overview.html" title=
"Chapter 1. Overview">
9 <link rel=
"prev" href=
"navigation.html" title=
"Navigation">
10 <link rel=
"next" href=
"hints.html" title=
"Other Hints and tips">
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>
22 <div class=
"spirit-nav">
23 <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>
26 <div class=
"titlepage"><div><div><h2 class=
"title" style=
"clear: both">
27 <a name=
"math_toolkit.conventions"></a><a class=
"link" href=
"conventions.html" title=
"Document Conventions">Document Conventions
</a>
28 </h2></div></div></div>
30 <a class=
"indexterm" name=
"id882016"></a>
33 This documentation aims to use of the following naming and formatting conventions.
35 <div class=
"itemizedlist"><ul class=
"itemizedlist" style=
"list-style-type: disc; ">
37 C++ Code is in
<code class=
"computeroutput"><span class=
"identifier">fixed
</span> <span class=
"identifier">width
</span>
38 <span class=
"identifier">font
</span></code> and is syntax-highlighted
39 in color, for example
<code class=
"computeroutput"><span class=
"keyword">double
</span></code>.
42 Other code is in block
<code class=
"literal">teletype fixed-width font
</code>.
45 Replaceable text that
<span class=
"bold"><strong>you
</strong></span> will need to
46 supply is in
<em class=
"replaceable"><code>italics
</code></em>.
49 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>;
50 that is, it is in
<em class=
"replaceable"><code>code font
</code></em> and its name is
51 followed by
<code class=
"computeroutput"><span class=
"special">()
</span></code> to indicate
52 that it is a free function.
55 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>;
56 that is, it is in code font and its name is followed by
<code class=
"computeroutput"><span class=
"special"><></span></code>
57 to indicate that it is a class template.
60 If a name refers to a function-like macro, it is specified like this:
61 <code class=
"computeroutput"><span class=
"identifier">MACRO
</span><span class=
"special">()
</span></code>;
62 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
63 macro. Object-like macros appear without the trailing
<code class=
"computeroutput"><span class=
"special">()
</span></code>.
66 Names that refer to
<span class=
"emphasis"><em>concepts
</em></span> in the generic programming
67 sense (like template parameter names) are specified in CamelCase.
71 <table xmlns:
rev=
"http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width=
"100%"><tr>
72 <td align=
"left"></td>
73 <td align=
"right"><div class=
"copyright-footer">Copyright
© 2006-
2010,
2012-
2014 Nikhar Agrawal,
74 Anton Bikineev, Paul A. Bristow, Marco Guazzone, Christopher Kormanyos, Hubert
75 Holin, Bruno Lalande, John Maddock, Jeremy Murphy, Johan R
åde, Gautam Sewani,
76 Benjamin Sobotta, Thijs van den Berg, Daryle Walker and Xiaogang Zhang
<p>
77 Distributed under the Boost Software License, Version
1.0. (See accompanying
78 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>)
83 <div class=
"spirit-nav">
84 <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>