How To Use This Documentation

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

Start your search with the

Table of Contents, but see also:
Hyperlinks (shown in two colors depending on whether they have been visited, or not).
Considerable work has been put into providing extensive links, so please use them!
Indexes that link directly to both words in the text and to reference documentation. Sometimes there are separate indexes for functions, class, macros, but often just one index. These are automatically produced, so there is some 'clutter'. If you know you are looking for a function, class or macro then a specific index will avoid most clutter.
Doxygen-derived C++ Reference section.

	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
	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.

Examples will often be your quickest way to find what you need to know. Examples often deliberately use many features, often in a contrived fashion. Snippets of syntax-colored code are used in the text. You can also use links to display the entire source code of examples in the example folder. You should be able to run these examples without modification and are often a very good starting point to write your own code.
Tests will also give examples of use. Like examples, there will be links to tests in the test folder.

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

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

	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
	It is wise that you follow these. Failure to do so will lead to incorrect, and very likely undesired, results.

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

C++ code is in root_ptr width font and is syntax-highlighted in color, for example double in blue.
Other code is in block teletype root_ptr-width font.
Replaceable text that you will need to supply is in italics.
If a name refers to a free function, it is specified like this: free_function(); that is, it is in code font and its name is followed by () to indicate that it is a free function.
If a name refers to a class template, it is specified like this: class_template<>; that is, it is in code font and its name is followed by <> to indicate that it is a class template.
If a name refers to a function-like macro, it is specified like this: MACRO(); that is, it is uppercase in code font and its name is followed by () to indicate that it is a function-like macro. Object-like macros appear without a trailing () and are often used to control options by being defined, perhaps with a specific value.
Names that refer to concepts in the generic programming sense (like template parameter names) are specified in CamelCase, for example IntegralRange.

To find what you are looking for try:

Details of all classes, functions, parameters, and template parameters are provided in the Boost root_ptr C++ Reference section.
See the indexes and click on links colored to show that they are links.
See indexes, and separate Class Index, Function Index, Macro Index.