Home | Libraries | People | FAQ | More |
Table of Contents
Elements:
boostbook
- Defines a BoostBook bookclass
- Declares a class or class templateclass-specialization
- A specialization (partial or full) of a class templatecode
- Mimics the code
tag in HTMLcompile-fail-test
- A testcase that should fail to compilecompile-test
- A testcase that should compile correctlycomplexity
- The time/space/etc. complexity of a functionconstructor
- Declares a constructor of the enclosing classcopy-assignment
- Declares a copy-assignment operatordata-member
- Declares a data member of a classdefault
- The default value of a function or template parameterdescription
- Detailed description of a constructdestructor
- Declares a destructor for the enclosing classeffects
- Declares the side effects of a functionenum
- Declares an enumeration typeenumvalue
- A single value of an enumerationfree-function-group
- A set of functions that are grouped together under one namefunction
- Declares a functionfunctionname
- References a function with the given nameheader
- Declares a C++ header with the given nameif-fails
- What it means when a testcase failsinherit
- Declares a base class of the enclosing class or structlib
- A library dependencylibrary
- Top-level element for a librarylibrary-reference
- Declares the reference material for a librarylibrarycategory
- Declares that the enclosing library is in this categorylibrarycategorydef
- Defines a new library categorylibrarycategorylist
- Categorized listing of librarieslibraryinfo
- Provides information about a librarylibrarylist
- Placeholder for an alphabetical list of librarieslibraryname
- References a library of the given namelibrarypurpose
- Describes in one short sentence or phrase the purpose of a librarylink-fail-test
- Declares a test that should compile but fail to linklink-test
- Declares a test that should compile and linkmethod
- Declares a method, i.e., a member functionmethod-group
- A set of methods that are grouped together under one namenamespace
- Declares a namespacenotes
- Non-normative notes about a function's semanticsoverloaded-function
- An overloaded functionoverloaded-method
- An overloaded methodparameter
- A function parameterparamtype
- The type of a function parameterpostconditions
- Conditions that must hold after the function returnsprecondition
- Conditions that must be met prior to executing a functionprogramlisting
- A sample of program codepurpose
- A short description of an entity's userationale
- Describes the rationale for a particular function's designrequirement
- A requirement/property in the Jamfile for a testcaserequires
- Declares the requirements of a functionreturns
- Description of the return value of a functionrun-fail-test
- A testcase that should compile and link, but fail on executionrun-test
- A testcase that should compile, link, and executesignature
- One signature of an overloaded function or methodsnippet
- Pulls in a code snippet from a programlisting
elementsource
- Defines source code for a testspecialization
- Defines the specialization arguments for a class specializationstatic-constant
- Declares a static constant, e.g., const int foo = 5;
.struct
- Declares a C++ structstruct-specialization
- A specialization (full or partial) of a struct templatetemplate
- Declares the template parameters of a class or functiontemplate-arg
- A template argument in a specializationtemplate-nontype-parameter
- A nontype template parametertemplate-type-parameter
- Declares a template type parametertemplate-varargs
- Declares a variable-length list of template parameterstestsuite
- Describes a library testsuitethrows
- Description of the exceptions thrown by a functiontype
- The type of an element or return type of a functiontypedef
- Declares a typedefunion
- Declares a C++ union or union templateunion-specialization
- A specialization (full or partial) of a union templateusing-class
- Injects the method and function names of a class into the local scopeusing-namespace
- Injects the declared names from a namespace into the local scopeCopyright © 2003-2005 Douglas Gregor |