Generating documentation

#1 I don´t understand your question:
- Load config
- select output format
- execute doxygen
- drink coffee
- look at reference documentation

Script and engine reference are two separate things.

#2 Ok so they are separate sets of docs. Just what I figured.

The main part of my questions is how to generate the text file it uses (scriptReferenceDump.cs). Looks like it is just torquescript so my guess is to just execute it by typing exec("scriptReferenceDump.cs"); in the console or something, but is there an easy way without having to lunch your entire game up?

Also does it grab things I made in script (Script classes, methods, functions) as well as those I opened to script in C++?

#3 Hey Nathan,

just look somewhere here in the forum, there is a function generating the whole tree of objects and functions you can aquire from script/aka console. I would need to spend some time now, but it´s quite easy.
It produces a c++ equal output which can be used by doxygen. And to answer the last question: yes it grabs everything!

#4 Yeah that is what the scriptRefrenceDump.cs does, just wondering the easiest way to run it.

#5 There are actually two functions in script that already do this such as WriteOutFunctions() and WriteOutClasses(). They would be located in your Core/scripts/client/scriptDoc.cs file. Just run these functions from inside your game and run doxygen on the 2 files that it generates.

Edit: Here are the functions just in case you don't have them.

function writeOutFunctions()
{
new ConsoleLogger(logger, "scriptFunctions.txt", false);
dumpConsoleFunctions();
logger.delete();
}

function writeOutClasses()
{
new ConsoleLogger(logger, "scriptClasses.txt", false);
dumpConsoleClasses();
logger.delete();
}

#6 Year, that´s what I had in mind and also used!

Thanks Joseph for giving the final advice!

#7 Thanks that is perfect!

#8 I found an issue with dump functions and the formatting of your comments that causes problems with generating documentation. I posted about it here: http://www.torquepowered.com/community/forums/viewthread/117287