1.2 Organization of Reference Guide

Following this introduction, the Threads.h++ Reference is divided into three parts:

Chapter 2, "Overview of Packages," contains a brief overview of each package of Threads.h++. A package is a set of classes that address a particular development area. The overview for each package contains a description of the package itself, its class hierarchy, and an index of its classes, global functions and macros.

Reference Section 1, "Globals," contains a listing of the global enumerator types, followed by global functions and macros. Entries for global functions describe the function and then list and describe any template parameters and associated macros.

Reference Section 2, "Class Descriptions," is an alphabetical listing of the classes in the Threads.h++ library. The entry for each class includes:

An illustration showing the inheritance hierarchy for that class.
The name of the Threads.h++ package that contains the class.
The header file(s) associated with the class.
A brief description of the class.
An example showing the use of the class, where appropriate.
Descriptions of the public interface, including typedefs, constructors, destructors, operators, and member functions. Descriptions of private or protected members are included if such information is necessary for the user to properly use the class.