Mike Lilligreen
d75d644b54
Fixed some merge conflicts between development and linux branches
|
11 tahun lalu | |
|---|---|---|
| .. | ||
| config | 11 tahun lalu | |
| input | 12 tahun lalu | |
| output | 12 tahun lalu | |
| .gitignore | 12 tahun lalu | |
| ReadMe.txt | 12 tahun lalu | |
| comment.rb | 12 tahun lalu | |
| doxysearch.cgi | 12 tahun lalu | |
| generateDocs.bat | 12 tahun lalu | |
| generateDocs.cs | 12 tahun lalu | |
| hhc.exe | 12 tahun lalu | |
| main.generateDocs.cs | 12 tahun lalu | |
ReadMe.txt
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.
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.