GSoC/GCI Archive
Google Code-in 2012 BRL-CAD

Doxygen cleanup ... for LIBBN

completed by: Mrowqa

mentors: Sean

BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.

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.


There are approximately 300 documented API function calls in LIBBN.


  • include/bn.h
  • include/plot3.h
  • include/vmath.h
  • src/libbn
  • misc/Doxyfile