1
Modification Help / ParseTS - Static TorqueScript documentation (and other stuff)
« on: August 02, 2015, 02:33:49 PM »
ParseTS
ParseTS will automatically build documentation for your project, sort of like Javadoc. Currently the output looks like this:
Usage:
Where <PATH> is either a file or a directory. The output should now be in dist/parsets-docs.
In order to add a documentation comment to a function, use the following style:
Installing:
You can also run directly from the source directory using the cabal run command.
ParseTS will automatically build documentation for your project, sort of like Javadoc. Currently the output looks like this:
Usage:
Code: [Select]
$ parsets docs <PATH>
Where <PATH> is either a file or a directory. The output should now be in dist/parsets-docs.
In order to add a documentation comment to a function, use the following style:
Code: [Select]
//| This function does X
function doX() {
}
Installing:
- Install GHC (tested against GHC 7.8, I recommend MinGHC if you're on Windows)
- Check out the docgen branch from GitHub
- $ cabal install
You can also run directly from the source directory using the cabal run command.