Boost C++ Libraries

Reference

Elements:

Element access - Declares an access specification for class members
Element boostbook - Defines a BoostBook book
Element class - Declares a class or class template
Element class-specialization - A specialization (partial or full) of a class template
Element code - Mimics the code tag in HTML
Element compile-fail-test - A testcase that should fail to compile
Element compile-test - A testcase that should compile correctly
Element complexity - The time/space/etc. complexity of a function
Element constructor - Declares a constructor of the enclosing class
Element copy-assignment - Declares a copy-assignment operator
Element data-member - Declares a data member of a class
Element default - The default value of a function or template parameter
Element description - Detailed description of a construct
Element destructor - Declares a destructor for the enclosing class
Element effects - Declares the side effects of a function
Element enum - Declares an enumeration type
Element enumvalue - A single value of an enumeration
Element free-function-group - A set of functions that are grouped together under one name
Element function - Declares a function
Element functionname - References a function with the given name
Element header - Declares a C++ header with the given name
Element if-fails - What it means when a testcase fails
Element inherit - Declares a base class of the enclosing class or struct
Element lib - A library dependency
Element library - Top-level element for a library
Element library-reference - Declares the reference material for a library
Element librarycategory - Declares that the enclosing library is in this category
Element librarycategorydef - Defines a new library category
Element librarycategorylist - Categorized listing of libraries
Element libraryinfo - Provides information about a library
Element librarylist - Placeholder for an alphabetical list of libraries
Element libraryname - References a library of the given name
Element librarypurpose - Describes in one short sentence or phrase the purpose of a library
Element link-fail-test - Declares a test that should compile but fail to link
Element link-test - Declares a test that should compile and link
Element method - Declares a method, i.e., a member function
Element method-group - A set of methods that are grouped together under one name
Element namespace - Declares a namespace
Element notes - Non-normative notes about a function's semantics
Element overloaded-function - An overloaded function
Element overloaded-method - An overloaded method
Element parameter - A function parameter
Element paramtype - The type of a function parameter
Element postconditions - Conditions that must hold after the function returns
Element precondition - Conditions that must be met prior to executing a function
Element programlisting - A sample of program code
Element purpose - A short description of an entity's use
Element rationale - Describes the rationale for a particular function's design
Element requirement - A requirement/property in the Jamfile for a testcase
Element requires - Declares the requirements of a function
Element returns - Description of the return value of a function
Element run-fail-test - A testcase that should compile and link, but fail on execution
Element run-test - A testcase that should compile, link, and execute
Element signature - One signature of an overloaded function or method
Element snippet - Pulls in a code snippet from a programlisting element
Element source - Defines source code for a test
Element specialization - Defines the specialization arguments for a class specialization
Element static-constant - Declares a static constant, e.g., const int foo = 5;.
Element struct - Declares a C++ struct
Element struct-specialization - A specialization (full or partial) of a struct template
Element template - Declares the template parameters of a class or function
Element template-arg - A template argument in a specialization
Element template-nontype-parameter - A nontype template parameter
Element template-type-parameter - Declares a template type parameter
Element template-varargs - Declares a variable-length list of template parameters
Element testsuite - Describes a library testsuite
Element throws - Description of the exceptions thrown by a function
Element type - The type of an element or return type of a function
Element typedef - Declares a typedef
Element union - Declares a C++ union or union template
Element union-specialization - A specialization (full or partial) of a union template
Element using-class - Injects the method and function names of a class into the local scope
Element using-namespace - Injects the declared names from a namespace into the local scope

Permission to copy, use, sell and distribute this software is granted provided this copyright notice appears in all copies. Permission to modify the code and to distribute modified code is granted provided this copyright notice appears in all copies, and a notice that the code was modified is included with the copyright notice.

This software is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.