« Moab hiking trails | Main | Numbered Pseudocode in Latex »

October 07, 2003

Doxygen, and how to use it

[Doxygen] is a free tool for generating HTML docuemtnation from existing C/C++, Java and other kinds of programs. It works pretty good, if you get some of the key options right. The most useful and obscure optoins for my purposes are...

  • EXTRACT_ALL = YES to extract all functions, not just the commented ones.
  • HAVE_DOT=YES to use dot to generate inheritance and call graphs.
  • CALL_GRAPH=YES to generate call graphs for glabal functions.
  • RECURSIVE=YES to recurse into source subdirectories,
  • FILE_PATTERNS= = *.h *.c *.C *.inc *.cpp to get all my .C source files.
Works great.

Posted by jones at October 7, 2003 10:32 PM

Comments

Post a comment

Thanks for signing in, . Now you can comment. (sign out)

(If you haven't left a comment here before, you may need to be approved by the site owner before your comment will appear. Until then, it won't appear on the entry. Thanks for waiting.)


Remember me?