| 1234567891011121314151617181920212223242526272829303132 |
- Generates Torque2D and TorqueScript reference documentation.
- 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.
- ***************
- A) Manual
- This should work for PC or Mac (or anywhere doxygen and git/svn run)
- 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
- ***************
- B) Automatic
- !! the following is an automated method that needs to be updated !!
- * Windows ***
- Execute the "generateDocs.bat"
- 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 however if you change the "scriptReference.Windows.cfg" and change the line "GENERATE_HTMLHELP" to "= YES" you will also get a compiled CHM file.
- * OS X ***
- 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.
|
