Game Development Community

documentation(s) ?

by Philippe Jofresa · in Torque Game Engine · 05/01/2003 (8:15 am) · 2 replies

Right, I have read the FAQs, I have searched the forums, and I'll be damn if I found a solution, so I *have* to ask it :
How do you guys do for the documentation ?

I mean, it's all fine well if you are running with the Net on 24/7, but I dont have that chance. So I thought, OK, I'll use this DOxygen thing and see if it's as cool as they make it sound...
well... I must be missing smoething because it does build some docs, but only from the command line (if I use the GUI given with the program, it simply seem to crash).
Is there somewhere where there would be a *clear* explanation on how I can build the damn docs using DOxygen ?
Would it be so hard to have a little readme file amongst the thousands other files of code in the SDK ?

Or did I miss something ?

Please ?

#1
05/01/2003 (10:41 am)
You run the command line doxygen app... That's about all there is to it. Doxygen was intended to be run this way; the GUI is a bit of a hack.

Rick Overman had some custom changes to the copy of Doxygen he used to do the "official" docs, but I think they got rolled back in to the latest release of the program.

Note that Doxygen won't generate all the stuff at www.garagegames.com/docs/torque.sdk/index.php. But perhaps if you ask the GG people nicely, they'll be able to send you a zip file of the page (or you could use a web spidering app).
#2
05/02/2003 (11:30 am)
Right, that's what I was worried about :/
Well, I'll just have to suck it up then...
download everything by hand. I guess it's better than nothing :)