Doxygen

Source code documentation generator

Doxygen is easy to use and very powerful

While assembling this site, I discovered YACT (yet another cool tool!) Doxygen can create documentation on the fly for large source code bases, and can make navigating large code bases easier. I spent almost zero time to get a basic output that produced a really nice set of HTML pages documenting the drupal code base that drives this site.

Doxygen relies on simple tags in the source code to provide comments and function declaration descriptions. Check out the man page or Doxygen Home Page for more details.

Here is what I did:

Doxygen is driven from a configuration file. From the top level directory of the project, I asked doxygen to produce a template config file for me:

Syndicate content