Format of the Documentation

This documentation is being generated by an "automated documentation" generator called Doc++ . The web pages are generated from markup embedded in the comments contained in the header files. This lets me keep one copy of the documentation up to date, then regenerate the on-line documentation automagically.

The structure and format of these class documentation pages is decided by the flexibility of doc++ and seems to be working out very well. The top section of the class documentation page gives quick, one-line descriptions of the class and its members together with the call description (the prototype for you C programmers). The bottom section of the page includes more detailed, multi-line explanations of the same.

  There is a "book" shaped marker  next to the class name at the top of a classes that, if you click on it, will take you to the detailed description of the class purpose.

  A blue sphere  next to the "quick" top description indicates that there is more than one line of description for a data member.  Clicking on a blue sphere sphere will transport you to the (usually more detailed) descriptions at the bottom of the page.

  If there is only one line (that is, you already see all there is to see) the sphere will be grey.

  Descriptions of class members that should be used with care (because you are allowed to do something that would shoot yourself in the foot) are marked with warning tape.

Classes, macros and other elements that are documented in the package have the format of HTML links (and look like whatever your browser is set up to show you). Click on one to follow the link to a description of that element.

The Doc++ software adds an "advertising banner" at the bottom of each HTML page, so if you are interested in Doc++ for your own software, follow the links provided there. :-)