Browse Source

- Added a read-me for the documentation generation tools.
- Removed the OSX generate-docs command for now as it's not ready.

MelvMay-GG 12 years ago
parent
commit
c941176
2 changed files with 18 additions and 28 deletions
  1. 18 0
      tools/documentation/ReadMe.txt
  2. 0 28
      tools/documentation/generateDocs.command

+ 18 - 0
tools/documentation/ReadMe.txt

@@ -0,0 +1,18 @@
+Generates TorqueScript reference documentation.
+
+***********
+* 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 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.

+ 0 - 28
tools/documentation/generateDocs.command

@@ -1,28 +0,0 @@
-#!/bin/sh
-
-cd "`dirname "$0"`"
-
-# --- Clean up the junk in the root of the scriptDocs folder ---
-rm scriptDocs/*.*
-
-cd scriptDocs/project
-sh generateProjects.command
-cd buildFiles
-sh compile.command
-cd ../../..
-
-# --- Dump the engine docs ---
-scriptDocs/project/game/ScriptDoc.app/Contents/MacOS/ScriptDoc
-
-# --- Build the doxygen docs ---
-cd ../Engine/bin/doxygen
-doxygen scriptReference.mac.cfg
-cd ../../../Documentation
-
-# --- Build docset ---
-
-cd scriptDocs
-make
-rm -rf ../com.garagegames.TorqueScript.docset
-mv -f com.garagegames.TorqueScript.docset ..
-rm *.* Makefile