Plan for Rick Overman
by Rick Overman · 08/14/2001 (11:03 pm) · 5 comments
I have been evaluating Doxygen as a source code documentation tool for the Torque Engine SDK. So far I am very pleased with how easy the tool is to use, its speed and the usefulness of the output. Obviously the Torque does not have Doxygen style comments imbedded in it yet so I have it configured to extract all code structures. I have also downloaded the GraphViz extension which produces incredible dependency graphs - be forewarned it takes a long time to generate all those graphs. I have compiled step by step directions to get Doxygen setup and running on your machine below.
I will be placing a copy of this documentation on the web site for Torque Engine SDK owners as soon as possible. Phase two will be going through the entire engine and making a first pass at commenting the major classes using Doxygen style commenting.
An Engine Overview document is also underway, by Mark Frohnmayer and early drafts should also be available it the near future. This overview document is a major undertaking so send Mark some encouragement e-mail. :)
--Rick
Generating Docs with Doxygen
Step:
1) Go to the Doxygen website and download the Doxygen zip file.
2) Extract the zip to your hard disk and add/doxygen-1.2.9.1/bin to your path
3) Download this Doxygen config file and place it in your/torque directory
4) If you wish to generate dependency graphs follow these sub-steps
4a) Go to the GraphViz WEBSITE and download GraphViz.
4b) place cygwin1.dll, dot.exe and neato.exe in/GraphViz and add it to your path
4c) edit line 710 and set HAVE_DOT = YES. NOTE: this will drastically increase the time it takes to generate the docs but will produce very useful dependency graphs.
5) From the/torque directory type: doxygen doxygen.cfg
6) The resulting docs will be placed in/torque/docs/engine/html
7) Enjoy.
I will be placing a copy of this documentation on the web site for Torque Engine SDK owners as soon as possible. Phase two will be going through the entire engine and making a first pass at commenting the major classes using Doxygen style commenting.
An Engine Overview document is also underway, by Mark Frohnmayer and early drafts should also be available it the near future. This overview document is a major undertaking so send Mark some encouragement e-mail. :)
--Rick
Generating Docs with Doxygen
Step:
1) Go to the Doxygen website and download the Doxygen zip file.
2) Extract the zip to your hard disk and add
3) Download this Doxygen config file and place it in your
4) If you wish to generate dependency graphs follow these sub-steps
4a) Go to the GraphViz WEBSITE and download GraphViz.
4b) place cygwin1.dll, dot.exe and neato.exe in
4c) edit line 710 and set HAVE_DOT = YES. NOTE: this will drastically increase the time it takes to generate the docs but will produce very useful dependency graphs.
5) From the
6) The resulting docs will be placed in
7) Enjoy.
#2
08/19/2001 (12:01 am)
Looks great, thanks!
#3
11/13/2002 (9:57 am)
Worked like a charm! Awesome! 
#4
Great resource. Of course, very useful for understanding Torque.
One comment for future readers:
Q: HOW LONG SHOULD IT TAKE TO GENERATE?
A: On a P4 1.8GHz machine w/ 512MB of mem, this took ~22 minutes to complete.
Factors -
o Ran with GraphViz dependency charts.
o Total memory (RAM) usage was about 120MB
o Main bottleneck seems to be CPU speed (as long as you have sufficient memory)
Again, good deal. Thanks for putting this resource together.
-Ed
02/23/2003 (1:57 pm)
Rick,Great resource. Of course, very useful for understanding Torque.
One comment for future readers:
Q: HOW LONG SHOULD IT TAKE TO GENERATE?
A: On a P4 1.8GHz machine w/ 512MB of mem, this took ~22 minutes to complete.
Factors -
o Ran with GraphViz dependency charts.
o Total memory (RAM) usage was about 120MB
o Main bottleneck seems to be CPU speed (as long as you have sufficient memory)
Again, good deal. Thanks for putting this resource together.
-Ed
Torque 3D Owner Pat Wilson