How To Use This Documentation

This documentation is prepared using the Boost Quickbook, BoostBook, Doxygen, Automatic Indexing toolchain.

Start your search with the

[Tip] Tip

The colored class and function names are links will lead you to an individual class, function, or macro. They are the key to finding what an item does, and about its parameters, template parameters, pre and post conditions, and what they return.

[Tip] Tip

Having found a class like negatable, use the find key to search for a specific function or value. For example, using the index to search for value_type will lead you to the (long) page of class template negatable, so then search for value_type and click on the link to get the detail. This is much quicker than simply scrolling.

The information given is derived from Doxygen-syntax comments in the include files, mainly root_ptr.hpp.


[Note] Note

These blocks typically go into more detail about an explanation given above.

[Tip] Tip

These blocks contain information that you may find helpful while coding.

[Important] Important

These contain information that is imperative to understanding a concept. Failure to follow suggestions in these blocks will probably result in undesired behavior. Read all of these you find.

[Warning] Warning

It is wise that you follow these. Failure to do so will lead to incorrect, and very likely undesired, results.

Document Conventions

This documentation aims to use of the following naming and formatting conventions:

To find what you are looking for try: