Downloadable/Printable docs?

#1 1) grab Doxygen
2) check under the doc dir of the TGE root dir

IE:

c:\torque\doc
3) run Doxygen
4) print to your hearts content ;)

-Ron

#2 Thanks Ron.

I actually ran Doxygen before I posted but wanted to see if anyone had managed to get the Reference doc one nice pdf file... I suppose I'll poke around with Doxygen some more and see if it will do what I want.

Thanks again!
-C

#3 You can get Doxygen to produce a PDF file, but it's a long, painful process, resulting in a HUGE PDF... You really don't want to bother. :) I had to do custom strange things to get it to work when I tried.

#4 The Doxygen page wont load for me:( Is it a tutorial?

#5 It's a comprehensive reference to the C++ side of Torque, and some overview documentation.

#6 Ben is right, I just tried generating a pdf under linux (Mandrake 9.2rc2). It generated a ~4000 page document running at ~40MB in size which is huge, though on the plus side it was fully index/linked.

In case anyones interested i had to modify 2 files for it to work (doxygen.html.cfg that is in doc/doxygen/html and texmf.cnf in /usr/share/texmf/web2c). Did the following toplevel in the torque tree :


doxygen doc/doxygen/html/doxygen.html.cfg
cd documentation/latex
make

the 2 modified files can be found at members.fortunecity.com/torktools/Misc/doxygen2pdf.tar.gz

addendum: i did this with Release_1_2_0 though it should work with the HEAD branch :)

#7 I'm impressed. When I tried it under windows the PDF tool tended to die on me. :)

#8 Ben: Yeah i had the same problem, till i figured out that i had to double the memory amounts in texmf.cnf. Thanks to google i found a reference to jadetex and tehn found the proper information on their page to hack the file. After that it took a good 15minutes on my XP1800+. I don't know what would be used under windows unfortunately :) .

#9

Quote:It's a comprehensive reference to the C++ side of Torque, and some overview documentation.

Is there a comprehensive reference to the script side of Torque coming soon?

#10 There's a tool called 'HMLDoc' http://www.easysw.com/htmldoc/
that converts html pages into pdf with indexes and such. I haven't yet tried it on doxygen output. It might do the trick for you.

#11 Forgive me if I'm wrong about this (fair lambasting expected :) ). I'm currently downlowding the TGE and have noticed that the Doc folder contains many other folders that in the most part are empty.
Going by the positings above, I should be able to print the documentation by using Doxygen, but so far Doxygen has refused to show its head.
Will the documentation download after the rest of TGE, or has there been some changes concerning the documentation being only online?

If the latter is the case, is here some way of getting the documentation so I am able to print it out. The reason for this is I am not on line while programming and having a pdf file of the documentation, or a printed version would be preferable.

Thanks in advance.

#12 Hey, everybody responds with doxygen. Its a very helpful resouce don't get my wrong but that just covers the c++ code. It really don't cover the getting started stuff.
I have to say there is something to be said for having some printed docs. If nothing else you can hit yourself with them until you get it. :).
This topic has come up a bit lately and there are people working very hard on the tutorials and documentation. Perhaps they can be convinced to have a downloadable version of the docs.

Later, Ben

#13 The doxygen doc is for C++ programmer, not very suitable for script programmer I think. I wait and see when GG release doc for script.

#14 The getting started docs are (or will soon be) in DocBook, which means among other things that one can easily print them.

And scripting docs are in the works, too, I'm sure. ;)

For the C++ reference stuff, Doxygen is really great, although the inability to print it is annoying.

#15 Ok so I should be able to use Doxygen, but as I posted above, there is nothing in the Doxygen folder except a header and footer html folder, a css file and a cfg file. At the moment my torque folder is sitting at 61mb and CVS is still downloading. I thought the TGE was just 17.8megs.
How big is the download in reality, and how much more has to download?
Thanks

#16 TGE is 17.8 or so megs that gets transferred over CVS due to compression. However it gets much larger when uncompressed on your harddrive.

As for Doxygen, its a seperate, free, open source program that you have to download. It's used in a lot of projects for creating documentation from code and comments. The files in the doc folder just set it up to produce output like that in the GG docs (or so I assume, never actually done it).

For scripting tutorials, theres the Torniquet one (spelling?) and lots of other little ones. For a complete reference I suppose you are stuck with downloading them one html doc at a time from GG. Unless you make them 'offline' webpages (in internet explorer), in which case IE will download and cache it all for you.

#17 Thanks Dylan. I'll check this Doxygen out while I'm waiting for the files to download.
I kinda though I might have to d/l each page from the web. Hope I dont have to do that, but if at a last resort... :)

#18 You probably want to do that very carefully, if you do it at all. It really puts a big strain on our webservers, and Rick tends to block people who try it.

I strongly suggest using Doxygen locally.

#19 Thanks Ben.

#20 'Ello,

Just bought Torque and got Doxygen up and running, produced some very shiny documentation and is really gonna help me get to grips with the code side of the engine... But unless I'm missing something, I can't find any way to get an offline copy of the SDK documentation (the one that starts at http://www.garagegames.com/docs/torque.sdk/index.php)

The machine I'm using Torque on isn't currently online, so I'm having to transfer everything onto it via a portable hard drive. I want to download the SDK documentation and transfer it across, but I don't really want to download every single html file individually and try to reassemble it all at the other end. Is there somewhere I can just grab a pdf or a zipped folder containing all the relevant html files in one go?