Ravl code is automatically documented using the CxxDoc documentation system. This
program runs through the entire source tree parsing all header files, plus any
other extra documentation files. CxxDoc creates a user-friendly HTML
reference manual for the code, complete with cross-referencing of type and
class names.
It actually creates two documentation trees: "User" and
Develop". User documentation is aimed at people who only want to use the
classes as they are and have no wish to know the details of how the work. As
such the user documentation only gives details of the public interface offered
by those classes which are intended for use in code using the RAVL library.
The 'develop' documentation on the other hand gives information about all the
elements of a class, including private member variables and functions. This
documentation is intended for people who wish to make changes to the library
to either extend to modify its functionality.
For a description of how to comment your code to get the most out of CxxDoc
see Ravl.Documentation.Code.