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

Move comments from source to header files ... move LIBBN comments

completed by: Skriptkid

mentors: Sean, Erik


BRL-CAD uses Doxygen source code comments to document the API. The comments need to be moved from .c source code files to the corresponding .h API header file. Note that this is a REALLY easy task, it is just cut-and-paste after all, so it just might take you more than a couple hours if you're inefficient with a text editor. Regardless, you must make sure you compile before and after to make sure you didn't introduce a typo because you're changing so many files.

There are less than 150 API comments across 17 files in LIBBN that need to be moved. This will find most of them:

grep -n -r -E '^/\*\*$' src/libbn | grep -v svn | grep -v '\*\*\*' | grep -v '@' 

ONLY move comments on functions that have a corresponding BN_EXPORT declaration in the include/bn.h header. It should take less than 30 seconds to review each one.


  • include/bn.h
  • src/libbn/*.c