Prerequisites for Actionscript documentation

• Flex 2 SDK

Prerequisites for Javascript documentation

• JSDoc
• For Windows users: ActivePerl
• HTML::Template – Perl module required by JSDoc
• For Windows users: Microsoft NMAKE – Build utility required by ActivePerl to install HTML::Template

Actionscript 3 Code Documentation

Example documentation:

/**
* class-description
*/
class-declaration

/**
* method-description
*
* @see method-name
* @param name description
* @return description
*/
method-declaration.

/** attribute-description */
attribute-declaration

Extracting the documentation from the sourcecode:

asdoc.exe -source-path /source/directory -doc-sources /source/directory -output /output/directory -window-title "Project Title"

Javascript Code Documentation

Example documentation:

/**
 * class-description
 *
 * @author author
 * @extends class-name
 * @see class-name
 * @version version
 * @constructor
 */
class-constructor-declaration.

/**
 * method-description
 *
 * @see class-name#method-name
 * @param {data-type} name description
 * @return description
 * @type data-type-of-return
 */
method-declaration.

Extracting the documentation from the sourcecode:

perl jsdoc.pl /source/directory --directory /output/directory --project-name "Project Title"

References for this post

• Adobe.com: Using ASDoc
• JSDoc Documentation