Doxygen cleanup for LIBBU

Doxygen cleanup for LIBBUBRL-CAD

Status: ClosedTime to complete: 100 hrs Mentors: Isaac Kamga, Hardeep Singh RaiTags: C, docs, documentation, doxygen, comments, cleanup, headers

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.

Uploaded Work

File name/URL	File size	Date submitted
task-46-clean-up-libbu-doxygen.diff	19.8 KB	January 03 2015 01:56 UTC

Comments

Andromeda Galaxyon January 2 2015 17:42 UTCTask Claimed

I would like to work on this task.

Deepak on January 2 2015 17:45 UTCTask Assigned

This task has been assigned to Andromeda Galaxy. You have 100 hours to complete this task, good luck!

Andromeda Galaxyon January 3 2015 01:59 UTC

For this submission, I've fixed all of the warnings coming from libbu files that are in the output of 'make dox', and I've tried to set up all of the include files so that a) the groups make sense and b) every function is following the correct @file declaration.

On a related note, I think that it might be a good idea to split up the other two doxygen cleanup tasks (rt wdb) because, this one has so far taken me ~3hrs and both of those look like they would be considerably more complex, since (for librt) there are significantly more functions and (for both) there is less pre-existing structure in the documentation.

Andromeda Galaxyon January 3 2015 01:59 UTCReady for review

The work on this task is ready to be reviewed.

Andromeda Galaxyon January 3 2015 02:52 UTCPatch already applied

starseeker already applied a slightly modified version of this patch to the main tree, so it probably won't apply cleanly.

Sean on January 3 2015 23:10 UTCTask Closed

Congratulations, this task has been completed successfully.