as2api

http://www.badgers-in-foil.co.uk/projects/as2api/

as2api is a JavaDoc-like API documention tool for ActionScript 2.0, released under the terms of the GPL.

The scripts are implemented in Ruby, and compiled command-line binaries are available for Windows and Mac OSX.

• Parses the actual ActionScript code, so you'll have a reference for methods even if you didn't comment them yet
• XHTML output, which can be styled with CSS
• Can include the syntax-highlighted source code of each .as file alongside the API reference, if you wish
• Uses JavaDoc comment syntax
• Can draw per-package type inheritance diagrams if you install GraphViz
• DHTML 'search' box in the navigation lets you find classes and methods by typing their names

Here are some other open source projects which include as2api support.

Simon Wacker's As2ant Ant tasks include support for generating documentation using as2api.

FlashDevelop includes a GUI to help you generate your docuemntation using as2api.

Byron Saltysiak is working on a flash plugin for Maven, which makes use of as2api to implement an API doc report (project doesn't seem to have been updated in a while though; still stuck on the old as2api-0.2).

Back to Documentation Systems