DreamingWell Generating ASDocs in Flex Builder 3

Generating ASDocs in Flex Builder 3

Posted by Travis Collins at September 29, 2009 1:38 PM

ASDoc's plethora of command line options can be frustrating to contend with. Here's an easy way to generate ASDocs for any project in Flex Builder 3.

Create a new "External Tool"
1. Click Run -> External Tools -> Open External Tools Dialog
2. Click the "new" icon to create a new external tool

Assign this tool the name "Generate ASDoc"

Under "Location" use the "Browse the filesystem button" to find the asdoc executable in your Flex SDK.
- Mac OSX: /Applications/Adobe Flex Builder 3/sdks/3.3.0/bin/asdoc
- Windows: C:\Program Files\Adobe Flex Builder 3\sdks\3.3.0\bin\asdoc.exe

Under "Working Directory" enter ${project_loc}

Under "Arguments" enter

-source-path=./src -doc-sources=./src -window-title="${project_name}" -main-title="${project_name}" -external-library-path=./libs

Click "Apply"

Click "Close"

To generate ASDocs for any project in Flex Builder, click on the project in the "Flex Navigator" list, and then click the "External Tools" button (or Run->External Tools->Generate ASDoc).

The "Console" window will show the warning and error output from asdoc. The generated docs will be placed in a new folder named "asdoc-output" at the root of your project.

If you receive an error about "variable references ... ${project_loc}", you didn't click on your Flex project before clicking "Generate ASDocs".