Offline Documentation

#1 Daniel,

The below steps should create the documentation locally:

1) Download and install doxygen
2) Modify the below line (30) in doc\doxygen\doxygen.html.cfg for your correct root directory (where you have Torque installed):

STRIP_FROM_PATH = e:/dev/torque/

3) Run doxygen to generate the documentation locally:

G:\doxygen\bin\doxygen.exe doc/doxygen/doxygen.html.cfg

NOTES: I do not have the doxygen binaries in my path so I use the fully qualified path to the executable. Make sure you run the above command from the root directory where Torque is installed.

Rich

#2 Thanks, that did the trick. I had never used doxygen before.

#3 One thing that would be very helpful for us raoming laptop users is a downloadable stuffit (or .zip) archive of all the linked documentation pages (all the chapters and their sub-pages, not just the doxygen stuff for the C++ files).

I've tried loading each page and printing to PDF in OS X, but that's very time-consuming, and gets tedious really fast.

#4 I could use some help on Doxygen.
1)I installed Doxygen
2)Installed GraphViz
3)STRIP_FROM_PATH = c:\torque in the doc\doxygen\doxygen.html.cfg file
4)set HAVE_DOT = YES with the doc\doxygen\doxygen.cfg file

After I completed these steps I ran the doc\doxygen\doxygen.html.cfg file from the torque directory. I asked what program I wanted to use to run it and I browsed to the doxygen.exe file. I created the documents and all seemed well.

When I open up the index.html file I got a runtime error asking if I wanted to debug. It did the same thing for every page I opened and every link I clicked on. Any ideas how I can get past all of these errors.

#5 Ok, never mind about the runtime error's. The problem was with my computer after the installation of some software. A quick restore cleared that up.

But I do have one question regarding GraphViz. Does GraphViz work automatically with Doxygen after installation or do I need to add them within some kind of path. I'm asking because of the following line written by Ricker Overman at the link below and I don't quite understand what he means.

4b) place cygwin1.dll, dot.exe and neato.exe in /GraphViz and add it to your path

http://www.garagegames.com/index.php?sec=mg&mod=resource&page=view&qid=1292

I could use some feedback on this please.

#6 The Engine Reference has another explanation of how to do this...

http://www.garagegames.com/docs/torque.sdk/engine/MakingDocs.php

#7 Thanks for responding and yes, I did read this. But it didn't say if their was any configuration changes necesary to effectivly use GraphViz besides installing it. I do know that altering the
HAVE_DOT = YES line to a "Yes" instead of the default "No" seemed to get me more graphics. But it's not mentioned in the
documentation found at http://www.garagegames.com/docs/torque.sdk/engine/MakingDocs.php
so I was wondering if their was anything else that was not mentioned in this document. Rick did mention something about adding some of the graphviz files to a path as listed in my previous post. Do you know what he meant by that?

#8 If you got better graphics by using dot, then it worked. No more changes necessary. :)

#9 Good, I finally got past that hurdle. Thanks for the reply.