[Alephmodular-devel] Documentation possiblity? Doxygen
Status: Pre-Alpha
Brought to you by:
brefin
From: Br'fin <br...@ma...> - 2003-10-15 14:21:06
|
I found this link over on MacOS X Hints. So I poked into it, tried running it over AlephModular and also over AlephOne. I could still do with touching up the relevant defines, but it seems to grok their structure well. Would/Could something like this be useful and would anyone ever getting around to updating the documenting tags to make such a thing even more useful? -Jeremy Parsons http://alephmodular.sourceforge.net/ Begin forwarded message: > Automatically document code (C++, PHP,...) with Doxygen > Tue, Oct 14 '03 at 10:16AM > from: Nimitz > > As a php coder, I'm sometimes overwhelmed by the sheer volume of code > I'm writing. Then I stumbled on Doxygen, a documentation generator > which reads your code and generates standard documentation pages about > it. Aside from HTML, you can also generate LaTex, RTF, Postscript, > Hyperlinked PDF's and Unix man pages. There's a Mac OS X version > available if you don't like to compile it yourself. > How does it work? Doxygen runs from the prompt and reads a > configuration file you have to prepare (once). The generated ouput is > then ready to use. Of course, if you extend your comments in your > code with the doxygen tags (like: author, version, to-do, etc.), your > output will become more useful, as doxygen does cross-referencing and > the works! > > ------------------------------------------------------------ > Comment on this story at > http://www.macosxhints.com/article.php?story=20031011120515689#comments > |