Organization of this Reference

This reference guide is generated from source code comments.

Related Pages: Contains reference documents such as the Deprecated List, a list of all deprecated classes, members, and non-members.

Topics: This tab provides a view into the product organization. Each level provides a list of classes and related functions.

Classes: Contains these four listings:

• Class List: An annotated alphabetical list of the classes in the API.
• Class Index: A concise alphabetical index of the classes in the API.
• Class Hierarchy: A hyperlinked class hierarchy.
• Class Members: A comprehensive index of class members and related functions in the API.

Search

Each page includes a search box that supports searching on symbols: classes, functions, variables, typedefs, enumerations, enumerators, and friends. To be clear, this is not full-text search, so searching on "hashmap" will return no matches, but "hash" will because many classes have a hash() function.

A dropdown menu in the search box allows restricting the search to a single type of symbol; the default is all symbols. The results show matching symbols, and if you click on one, you will see a list of all places where the symbol is documented. Click the close icon on the right side of the search box to close the results box.

Inherited Members

The main class description page only documents members declared in the class. That is, it does not document inherited members inline. To see the list of all members, whether declared in the class or inherited from a base class, click the List of all members link near the top of the class description page.

Conditional code elements

Some code elements are tagged as conditional, as indicated in the description by:

Condition: Reason for the limitation ...

Most commonly this is because the code element depends on functionality that not all compilers support, such as recent changes to the C++ standard. In some cases, they reflect specific problems related to a platform or compiler. Note that use of these code elements may limit the portability of your code.