Content of the Documentation

(assumptions about your knowledge)

This documentation assumes that you are familiar with how "C++ the language" operates. The documentation describes each class that you need to understand how to use this software, together with the public (user accessible) data members and member functions that you might care about. The veteran C++ programmer is invited to look directly at the the header files (and class definitions in example code files) to see the finer details with greater resolution. That is, there is more under the hood than is explained in this documentation; the profesional mechanic is welcome to take a gander.

The non-C++ programmer should not immediately turn away, however. The example programs are intended to be read. That is, I've tried my best to design the classes so you can just read the code as if it were plain English and understand what actions are taking place, even if how those actions are accomplished is not obvious. A person with some knowledge of C programming should be able to start with one of the example programs and make modifications until the code does what she wants.

In summary, this documentation provides a high level description of the important classes and their purposes together with excerpts from the class definitions. The excerpts include public member function descriptions (straight from the class definition) together with text describing (sometimes tersely) the intended uses of those member functions. The same is done for important public data members. Once you have an understanding of how the class objects are to be used together, these descriptions should be enough to get you started doing useful things.