T3D Engine Reference - How To:
by Richard Ranft · in Torque 3D Beginner · 01/31/2013 (6:46 am) · 13 replies
You can generate the engine reference locally.
Assuming you have Torque 3D MIT checked out;
Start by pulling down the Torque 3D Documentation repository.
Edit - thanks Steve
Pull down doxygen and get it into your Engine/bin folder in a subfolder named doxygen.
Get a copy of the HTML Help Workshop from Microsoft and copy the compiler (hhc.exe) into your doxygen folder.
Next, copy the Documentation folder into your Torque 3D MIT folder at the top level (should be next to the Engine folder).
Inside your copy of the Documentation folder, double-click the generateEngineReference.bat file and sit back for a minute. Maybe get a cup of coffee.
You should now have a file titled Torque 3D - Engine Reference.chm.
Assuming you have Torque 3D MIT checked out;
Start by pulling down the Torque 3D Documentation repository.
Edit - thanks Steve
Pull down doxygen and get it into your Engine/bin folder in a subfolder named doxygen.
Get a copy of the HTML Help Workshop from Microsoft and copy the compiler (hhc.exe) into your doxygen folder.
Next, copy the Documentation folder into your Torque 3D MIT folder at the top level (should be next to the Engine folder).
Inside your copy of the Documentation folder, double-click the generateEngineReference.bat file and sit back for a minute. Maybe get a cup of coffee.
You should now have a file titled Torque 3D - Engine Reference.chm.
About the author
I was a soldier, then a computer technician, an electrician, a technical writer, game programmer, and now software test/tools developer. I've been a hobbyist programmer since the age of 13.
#2
01/31/2013 (9:03 am)
Actually would this be a bad time to point out that T3D MIT engine folder doesn't have the doxygen directory in it?
#3
Besides, tea is too civilized.
Ok, had to add a few steps - it's getting complicated up in here....
01/31/2013 (9:42 am)
Man, what's up with that...?Besides, tea is too civilized.
Ok, had to add a few steps - it's getting complicated up in here....
#4
:-p
01/31/2013 (10:16 am)
@Richard, would you believe that some of us that visit your forums ARE civilised! (note a Civilised 's'):-p
#5
But I'm too barbaric to handle tea well. Just ask Mich.
01/31/2013 (10:34 am)
You know, I typed civilised just for Steve and I was Americanized by my browser.But I'm too barbaric to handle tea well. Just ask Mich.
#6
01/31/2013 (11:54 am)
There is a reason we threw that crap in the Boston harbor. ;) 
#8
Here is the error I'm getting Could Not Find C:\Users\Dregen\Documents\GitHub\Torque3D\Documentation\doxygen.log
I'm missing the log file.
02/02/2013 (2:38 pm)
I seem to having some issue's with getting it to generate the ref files.Here is the error I'm getting Could Not Find C:\Users\Dregen\Documents\GitHub\Torque3D\Documentation\doxygen.log
I'm missing the log file.
#9
03/27/2013 (3:44 am)
I have the same problem as Jimmy. Can anyone tell me how to get doxygen.log?
#10
doxygen.log should be generated when you run doxygen. The thing I'm wondering is where it's being dropped. Let me look at how the old T3D 1.2 doc generation was set up and perhaps I can find a work-around.
Hey, Steve - I only drink filtered water. If it has been filtered through ground coffee beans....
03/27/2013 (9:30 am)
Sorry - just noticed this....doxygen.log should be generated when you run doxygen. The thing I'm wondering is where it's being dropped. Let me look at how the old T3D 1.2 doc generation was set up and perhaps I can find a work-around.
Hey, Steve - I only drink filtered water. If it has been filtered through ground coffee beans....
#12
And that batch file may no longer be available.... I'm going to have to host some files on my site for this to work in perpetua.
05/20/2013 (8:40 am)
Hey Mike - I saw that and forgot to mention that the code is my reference - but some people don't like to read code so I thought I'd throw them a rope.And that batch file may no longer be available.... I'm going to have to host some files on my site for this to work in perpetua.
#13
and by the way,
I downloaded Doxygen and it is possible to use Doxywizard interface to do Engine-Reference document.
07/17/2013 (12:15 pm)
Thank you Richard for small but good tutorial,and by the way,
I downloaded Doxygen and it is possible to use Doxywizard interface to do Engine-Reference document.
Associate Steve Acaster
[YorkshireRifles.com]
Alternatively ... have a nice cuppa tea.
Or possibly rough it with some sort of ghastly sugary, carbonated beverage which sends young people a bit hyperactive.