Friday, June 8, 2012

Auto-Documentation - Revisited

Auto-Documentation has been around for quite a while. However, most applications don't cover a wide range of file types (e.g. some are more specific to c/c++, etc). I couldn't get some of the "famous" projects (like "Doxygen") to do exactly what I wanted to do with such a wide range of code types in a lot of my personal SVN repos. So, I did what any red-blooded geek would do. I wrote one. Sure, it still needs some work, but the reality is that it will use Doxygen formats for the C/C++ files to generate documentation, perl (scripts and modules), some of the graphics (and POV-Ray stuff) I have in the repo, and feeds the results through the template-toolkit for the result, and it will do surgical updates just on specific files when something is checked into the repo. Sure, some of you will say "github". But, like the arguments between "RedHat" vs. SuSE, or "Vi" vs. "Emacs", it's a matter of what you cut your teeth on, and SVN (and CVS, used for a decade) still meet my needs perfectly.

No comments:

Post a Comment