The BaseTen framework has been extensively annotated with Doxygen comments, enabling you to generate human-readable documentation simply by pointing Doxygen at the BaseTen source tree. Using Doxygen is simple. First, install it with MacPorts:
sudo port install doxygen
If you get errors in Leopard try installing as root. If that doesn't work install each failed dependancy manually by following the instructions on the MacPorts website. Then, at the root of your BaseTen working copy, run doxygen. We have a shell script for running it, postprocessing and creating an Xcode documentation set:
Tools/run_doxygen.sh
This will create the Documentation folder, inside of which you'll find the BaseTen documentation in HTML and LaTeX formats. In the latex folder, you can run make to generate PDF documentation:
cd Documentation/latex make
The result will be a PDF file quite like the one above.
