Creating a help file for T2D engine docs
by Charlie Malbaurn · in Torque Game Builder · 03/12/2005 (1:10 am) · 5 replies
Ok,
Out of the need for engine docs, I created a .chm file based on the original resource by Daan Broekhof.
To do so for T2D you need a couple of files that are not in the sdk. Follow these directions and then you will be all set.
I'm sure a lot of you could or have figured out this already but I figured I would post it just in case.
Right now, this will only work for the people who have a TGE license. After I get permission from GG, I will include the files needed.
First do this:
1) Go to your TGE/SDK/ folder and copy all the folders in the doc folder.
2) Copy those folders into your T2d/SDK/doc folder.
3) Go to your TGE/SDK/Engine folder and copy engine.changelog.txt and engine.overview.txt files
4) Copy those files to your T2D\SDK\engine folder
5) Follow the instructions on this resource
Example: How-to generate the documentation in Windows Help file format (chm)
And that should be it.
Please remember that the files that you are removing from TGE (engine.changelog.txt and engine.overview.txt) have information about TGE in them. Until (or if) they create doxygen stuff for T2D the files will come off a little weird. Namely they will have TGE overviews etc.... But the hierarchy and all that are correct.
For now though, it's a good way to see what's going on inside T2D
Out of the need for engine docs, I created a .chm file based on the original resource by Daan Broekhof.
To do so for T2D you need a couple of files that are not in the sdk. Follow these directions and then you will be all set.
I'm sure a lot of you could or have figured out this already but I figured I would post it just in case.
Right now, this will only work for the people who have a TGE license. After I get permission from GG, I will include the files needed.
First do this:
1) Go to your TGE/SDK/ folder and copy all the folders in the doc folder.
2) Copy those folders into your T2d/SDK/doc folder.
3) Go to your TGE/SDK/Engine folder and copy engine.changelog.txt and engine.overview.txt files
4) Copy those files to your T2D\SDK\engine folder
5) Follow the instructions on this resource
Example: How-to generate the documentation in Windows Help file format (chm)
And that should be it.
Please remember that the files that you are removing from TGE (engine.changelog.txt and engine.overview.txt) have information about TGE in them. Until (or if) they create doxygen stuff for T2D the files will come off a little weird. Namely they will have TGE overviews etc.... But the hierarchy and all that are correct.
For now though, it's a good way to see what's going on inside T2D
About the author
#2
The T2D class hierarchy is in place and most of the TGE core stuff is fully documented. Give it a go if you don't have TGE and see what you think.
This was a very good suggestion, Charlie. Thanks!
03/12/2005 (8:48 am)
Just pointing doxygen to the engine folder of my stock T2D install worked reasonably well. (no editing of anything and I don't have TGE)The T2D class hierarchy is in place and most of the TGE core stuff is fully documented. Give it a go if you don't have TGE and see what you think.
This was a very good suggestion, Charlie. Thanks!
#3
03/12/2005 (12:16 pm)
When I did it, I didn't have much time to mess with it. When I went to sleep I figured that I could have done without the engine files. But not being a doxygen user, thats the best I could come up with.
#4
www.garagegames.com/mg/forums/result.thread.php?qt=27635
03/24/2005 (9:18 am)
Just to cross refference, here is a awsome little thing that will list all of T2d classes and methods.www.garagegames.com/mg/forums/result.thread.php?qt=27635
#5
"writeOutAllFunctions();"
and
"writeOutAllClasses();"
if all goes well will also make a text file including this info in your .exe directory
03/24/2005 (9:56 am)
Just to chime in... you can type in these commands in the console"writeOutAllFunctions();"
and
"writeOutAllClasses();"
if all goes well will also make a text file including this info in your .exe directory
Torque Owner Harold "LabRat" Brown