You just put tags and comments in your program and Doxygen will automatically
generate html from all your functions and whatever and create a nice browsable
document of your code.
I just found this program and a few others like it, does anyone know of any
other/better ones?
Doxygen is the best I’ve yet seen.–
Marc A. Lepage http://www.antimeta.com/
Minion open source game, RTS game programming, etc.
You just put tags and comments in your program and Doxygen will automatically
generate html from all your functions and whatever and create a nice browsable
document of your code.
I just found this program and a few others like it, does anyone know of any
other/better ones?
-Garrett, WPI student majoring in Computer Science
"The fastest way to succeed is to look as if you’re playing by somebody
else’s rules, while quietly playing by your own." -Michael Konda
For most purposes, Doxygen is as good as any tool that I’ve seen (though
embedding TeX a la Literate Programming still rocks, of course).
The main advantage with docs embedded in source files is that it brings
documentation closer to the code, so doc updates come naturally with
changes in the source. It would make it much easier to keep documentation and
code in sync.
Unfortunately Doxygen requires Qt, but maybe we can live with that.
The SDL documentation project is already well under way and while doxygen
was considered several people expressed concern with this form of
"intrusive" documentation.On Sun, 9 Apr 2000, Marc A. Lepage wrote:
Mattias Engdeg?rd wrote:
Unfortunately Doxygen requires Qt, but maybe we can live with that.
You just put tags and comments in your program and Doxygen will automatically
generate html from all your functions and whatever and create a nice browsable
document of your code.
I just found this program and a few others like it, does anyone know of any
other/better ones?
You just put tags and comments in your program and Doxygen will automatically
generate html from all your functions and whatever and create a nice browsable
document of your code.
I just found this program and a few others like it, does anyone know of any
other/better ones?
-Garrett, WPI student majoring in Computer Science
"The fastest way to succeed is to look as if you’re playing by somebody
else’s rules, while quietly playing by your own." -Michael Konda
There a couple of problems with all of these in-code documentation
ideas. The first is that it doesn’t work so well for multilanguage
support. One other is that it puts all the work back on the programmer
to do all the documenting, and as far as I know that group of people
consists of:
Sam.
(I’m right in thinking that everything goes through him, yes?)
We’ve got a bunch of people redoing all the doc stuff in sgml (and
therefore most any other format you’d want too). This will be a
comprehensive reference, and we shouldn’t have much touble keeping up to
date with any api changes.
(I’m right in thinking that everything goes through him, yes?)
Yup.
We’ve got a bunch of people redoing all the doc stuff in sgml (and
therefore most any other format you’d want too). This will be a
comprehensive reference, and we shouldn’t have much touble keeping up to
date with any api changes.
Sounds great!
-Sam Lantinga, Lead Programmer, Loki Entertainment Software
