BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output. There are approximately 300 documented API function calls in LIBBU.

References:

• http://www.jiggerjuice.net/software/doxygen.html
• http://www.stack.nl/~dimitri/doxygen/starting.html
• http://www.stack.nl/~dimitri/doxygen/

Code:

• include/bu.h
• src/libbu
• misc/Doxyfile

This task involves cleaning up the Doxygen comments in the library so that useful reports and API documentation automatically generated (correctly, completely, and cleanly). Verify/fix any Doxygen syntax. Verify/fix groups so that functions are organized neatly and all contained within a group. Provide patches that give clean (PDF) output from Doxygen.

Discuss with us if you end up needing to spend more than a few hours making corrections. Breaking this task up into multiple tasks is a possibility if warranted, but discuss with the developers in advance.