MathCore documentation ReadMe

The Developer's Guide is the main documentation source for programmers using the MathCore library; it should be already present in the docs/html folder if this module was downloaded from the WWW. Anyway, if you checked it out from the CVS or the documentation is not present, then you have to build it yourself.

The Developer's Guide is a set of HTML files which is created by a doc generator called Doxygen using the comments that the programmers embedded in the sources. Doxygen can be configured to create the documentation in a lot of formats: HTML (the default), CHM, RTF, Man, LaTex.... if you want more info about Doxygen, please refer to its website: www.doxygen.org.
The following paragraph explain how to create the Developer's Guide.

How to extract documentation from MathCore sources using Doxygen

To extract the most updated version of MathCore documentation from the MathCore sources using Doxygen, browse to the folder containing this readme file and then type the following command at the prompt:

Now you have in the docs/html folder the most updated documentation of MathCore: open docs/html/index.html and admire the brand-new docs :-)

If the new documentation misses the diagrams or you get an error about DOT, you must open the files called 'Core.doxygen' located in the same folder of this ReadMe and change the lines

Then, repeat the command above (./DocGen.sh or DocGen) and everything should work.
However, this external tool called 'Dot' (which is downloadable at: http://www.research.att.com/sw/tools/graphviz/download.html) is very useful; if you often use Doxygen documentation, you can't miss it !!!