...one of the most highly
regarded and expertly designed C++ library projects in the
world.
— Herb Sutter and Andrei
Alexandrescu, C++
Coding Standards
This documentation makes use of the following naming and formatting conventions.
fixed width
font
and is syntax-highlighted
in color.
italics
.
code
font
followed by ()
, as in free_function()
.
class_template<>
;
that is, it is in code font and its name is followed by <>
to indicate that it is a class
template.
MACRO()
;
that is, it is uppercase in code font and its name is followed by ()
to indicate that it is a function-like
macro. Object-like macros appear without the trailing ()
.
Note | |
---|---|
In addition, notes such as this one specify non-essential information that provides additional background or rationale. |
Finally, you can mentally add the following to any code fragments in this document:
// Include all of Pool files #include <boost/pool.hpp>