AS2NDAC (AS2NaturalDocsAutoComment)

A Perl script which automatically creates NaturalDocs comments for AS2.0 Class and Interface .as files. It's based on G.Wygonik's JSFL AS2.0 autodocumentor for NaturalDocs. This alpha release creates useable comments, however, no additional options are supported, see below for proposed roadmap

The AS2NDAC project is listed on OSFlash.org

Current Functionality

Presently the test version expects 2 filenames, inputFile & outputFile. It then parses the inputFile, creates the NaturalDocs compatible documentation comments and writes the outputFile.

The following auto commenting takes place...:

Interface definitions

Only interface declarations not directly preceeded by a block comment are parsed.

• interface name
• description stub
• extended interface
• ToDo Stub
• Note Stub
• Version stub
• Author stub

Interface method declarations

Only interface methods declarations not preceeded by a block comment are parsed.

• method name
• description stub
• parameter list
  • parameter name
  • data type
  • parameter description stub
• return type

Class definitions

Only class declarations not preceeded by a block comment are parsed.

• class name
• description stub
• dynamic and intrinsic attributes are noted in the description
• extended super class
• implemented interfaces
• Usage stub
• Example stub
• ToDo Stub
• Note Stub
• Version stub
• Author stub

Class method declarations

Only class methods declarations not preceeded by a block comment are parsed. Functions declared within other methods are not parsed, also functions declared as properties and defined inline will also fail to document correctly.

E.g. public var testFunction:Function = function(){ // my code } Would fail.

• method name
• description stub
• member access (private, public, static)
• parameter list
  • parameter name
  • data type
  • parameter description stub
• return type

Class property declarations

Only class properties not preceeded by a block comment are parsed. Properties declared within methods are not parsed, also functions declared as properties and defined inline will also fail to document correctly.

E.g. public var testFunction:Function = function(){ // my code } Would fail.

• property/var name
• description stub
• member access (private, public, static)
• data type

Click here for a short example class autodocumented with the script.

Roadmap

The following features are under consideration for future releases, there are no updates planned at present. (I'm too busy! Sorry!)

Config File - Various options specified in a (XML based) configuration file.

• Default author & version
• Default documentation stubs
• Structure specific documentation options
• Miscellaneous documentation options

Multiple filename & input/output folder - I will be adding better filename support so that you can parse a set of files without writing an additional .bat script. This will be done when the code parsing has been tested properly and the feature set for single file parsing is stable.

C# .NET based GUI version. - This is currently in development.

Known issues

• UTF8 BOM - UTF BOM files seem to cause some problems.
• Multiline method definitions - When functions are defined over multiple lines the complete parameter list and return type are not found, since documentation comments will only include whatever is on the same line as the function keyword. You may be in the habit of creating multi-line parameter lists, (I was) and this will be addressed in a later version.

Alpha Release

Download AS2NDAC v0.1 (alpha)