Blockland Forums > Suggestions & Requests

Javadoc-Style Documentation Script

Pages: (1/1)

Greek2me:

I'm requesting a script that parses Torquescript files and creates an HTML documentation file of all functions and methods. It should follow the Javadoc formatting standards, here: http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#format

It should be a fairly easy script to write. If any scripters have some spare time, I would really appreciate your work. Thanks!

Port:

As a command line utility, perhaps?

Something like $ tsdoc p1 p2 ... pN, p being a file path or a pattern.
For example: $ tsdoc server.cs scripts/*.cs

Or perhaps specifying a folder ($ tsdoc Script_HelloWorld) would create a multi-file HTML documentation of all the .cs files found in it, optionally going through child folders (with something like a -r/--recursive flag).

Greek2me:

--- Quote from: Port on June 07, 2013, 03:18:16 AM ---As a command line utility, perhaps?

Something like $ tsdoc p1 p2 ... pN, p being a file path or a pattern.
For example: $ tsdoc server.cs scripts/*.cs

Or perhaps specifying a folder ($ tsdoc Script_HelloWorld) would create a multi-file HTML documentation of all the .cs files found in it, optionally going through child folders (with something like a -r/--recursive flag).

--- End quote ---
Yeah, that would be great. It doesn't really matter if it's written in TS or not.

Pages: (1/1)

Go to full version