Online docs

#1 If memory serves, the reason was that it takes up too much bandwidth - the docs are larger than the engine, and the engine's bandwidth requirements are bad enough. Plus it allows them a little more flexibility on security (so that the docs don't get viewed by unathorized users). Finally, as the engine is changing, so can the docs.

Schnapple

#2 I think GG should make printable versions of the documents like .docs or something so that it prints smoothly and not cut off words. If not they should do something to make the docs avaible offline. I know they are very busy and everything helping us with the engine but having documents avaible to developer offline will help a bunch for those that don't want to sit online and do it or try to figure out what the cut words are. Just my opinion.

Bryan

#3 I'm pretty sure there's a way to get stuff other than HTML out of Doxygen. Check the docs.

#4 Doxygen can generate:
* HTML
* Compiled Hypertext Markup (CHM)
* Latex
* Rich Format Text (RTF - works well in Word)
* Portable Document Format (PDF)
* Postscript
-- more still in the latest version; I forget what all else is available.

Which formats are available depends on your Doxygen version, the 3rd party software you have installed (CHM requires Microsoft HTML Help Workshop, for example), and settings in the Doxygen configuration file.

I personally have modified the configuration file out of CVS to generate the CHM format with searchable index; if you are using MSVC, you can integrate it into the help system. If you're using CodeWarrior (like I am), it's still a lot faster than sifting through the HTML.

The copy with the source should always be the most up to date; theoretically, when someone writes new code in the CVS project, they're going to add the Doxygen markup to the routine. When they make a change, they'll change the Doxygen markup.

So, Doxygen will always be up to date.

http://www.doxygen.org to get Doxygen, if you don't already have it. There are instructions there on how to get RTF, PDF, etc., output, as well as information on what tools you need to be able to get that output.

ALL of the tools are free; some of them are less than easy to use on Windows. If you're not familiar with Unix, you probably want to stick to just CHM formatted files.

There are some nice add ons, too. For example, I have AT&T DOT, and if I change an option from "No" to "Yes" in the Doxygen config file, I get pictures of the class hierarchy that look a lot nicer than the normal ones Doxygen generates.

Dave

#5 If you get any version greater than 1.0 from CVS you can build HTML versions of the Doxygen code docs yourself. You will need doxygen and the unix utils installed and on your path. (both small downloads)

Then from the /torque directory type:

make docs

I tried to make it as hard as possible ;)

--Rick