|
|
@@ -1,6 +1,8 @@
|
|
|
Generates Torque2D and TorqueScript reference documentation.
|
|
|
|
|
|
-Use the manual (A) or automated (B) method. Note that the automated method needs some updating and testing
|
|
|
+The latest Doxygen for Windows/OSX can be found here: http://www.stack.nl/~dimitri/doxygen/download.html
|
|
|
+
|
|
|
+Use the manual (A) or automated (B) method. Note that the automated method needs some updating and testing.
|
|
|
|
|
|
***************
|
|
|
|
|
|
@@ -8,10 +10,11 @@ A) Manual
|
|
|
|
|
|
This should work for PC or Mac (or anywhere doxygen and git/svn run)
|
|
|
|
|
|
- 1. start in this directory
|
|
|
- 2. run doxygen config/torque2DReference.cfg (will produce ./output/torque2DDocs and torque2D.tag)
|
|
|
- 3. run doxygen config/torqueScriptReference.cfg (will produce ./output/torqueScriptDocs)
|
|
|
- 4. "push" output/torque2DDocs and output/torqueScriptDocs to gh-pages
|
|
|
+ 1. download Doxygen as noted in the link above. Move the exe/app into this folder.
|
|
|
+ 2. start in this directory
|
|
|
+ 3. run doxygen config/torque2DReference.cfg (will produce ./output/torque2DDocs and torque2D.tag)
|
|
|
+ 4. run doxygen config/torqueScriptReference.cfg (will produce ./output/torqueScriptDocs)
|
|
|
+ 5. "push" output/torque2DDocs and output/torqueScriptDocs to gh-pages
|
|
|
|
|
|
***************
|
|
|
|
|
|
@@ -27,4 +30,3 @@ This should produce an output file in the sub-folder "input" followed by executi
|
|
|
|
|
|
Execute the "generateDocs.command"
|
|
|
This should produce an output file in the sub-folder "input" followed by executing the Win32 Doxygen to generate the documentation in the output sub-folder. The default configuration only outputs HTML.
|
|
|
-The latest Doxygen for OSX can be found here: http://www.stack.nl/~dimitri/doxygen/download.html Shortly the OSX version will be placed into the repository alongside the DMG version.
|
Mike Lilligreen