Documentation Tool for ActionScript

Posted: August 1, 2008 in Best Practice
Tags:

AS2Doc
AS2Doc is a powerful, easy to use and fast documentation generator for your ActionScript 2 based classes. AS2Doc reads your source code, included comments and creates a rich content documentation automatically! You can choose various options to customize your documentation. Various output formats are supported by using AS2Doc Styles (XSL). You can even write your own style for any custom output format!

Online Page: http://www.as2doc.com/

AS2Docular v0.9.6
AS2Docular is a free, web-based application used to generate HTML documentation for Flash ActionScript 2.0 (.as) files. Like other tools of its kind, it uses ActionScript comments and code to decide the content of the documentation generated. For more on correctly commenting a file for AS2Docular, see Commenting ActionScript for AS2Docular. AS2Docular also support predefined template for documentation style. The best part of this tool is easy to use.

Online Page: http://www.senocular.com/projects/AS2Docular/standalone.php

ZenDoc
ZenDoc is a simple, free, (primarily) web-based application written in PHP used to generate customizable HTML documentation for Flash ActionScript 2.0 and ActionScript 3.0 source files. Like other tools of its kind, it uses Javadoc-style comments within source code to decide the content of the documentation generated.

Online Page: http://www.zendoc.org/zendoc/

ACID
ACtion Info Doc, (Acid), is written in Python, for ActionScript2 class api-doc generation. Include command-line script (acid) and GUI (wxAcid).  AS2 class analysis, grab info of the super, interface, constructor, properties and methods. Support most javadoc tags with some variants.  Supported Tag are for class, @author, @version; for properties, @throws; for methods, @param, @return, @throws; general, @see.

Online Page: http://icube.freezope.org/acid

VisDoc
VisDoc generates html documentation from ActionScript 2.0, 3.0 and Java class files. VisDoc integrates a smart processor to parse class files – you don’t need to prepare or rewrite your classes. Even if you don’t use doc comments, you can generate handy class documentation with a Table of Contents.

VisDoc is only available for Mac Os.

Online Page: http://visiblearea.com/visdoc/

AS2API
AS2API parses ActionScript 2 source code and generates HTML API documentation in the style of JavaDoc. It is open source, and runs on Windows, MacOSX and Linux.

For ‘FlashDevelop’ (ActionScript Editor) user has a best option to use AS2Doc. FlashDevelop already configured with AS2Doc tool.

Step to use AS2Doc in FlashDevelop:
step1
1. Tools -> Flash Tools -> AS2API
2. Enter Documentation Page title in <Page Title> field.
3. Enter Package name to be documented in <Package> field.
4. Enter output dir path where documentation to be created in <Output Dir>.
5. Select classpath of package to be documented using <Brows> option.
6. Click on <Generate Documentation> button for generate document.

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

 

🙂

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s