Home > Quick Tip > Quick Tip – Generating AsDoc

Quick Tip – Generating AsDoc

November 7th, 2009 brupp Leave a comment Go to comments

AsDoc is a command line tool for generating API documentation for as HTML pages of your packages/classes.

I prefer to use it as external tool running inside the Flex Builder. It provides a console window to diagnose any issues that might occur during HTML generation.

1) Go to Run->External Tools->Open External Tools Dialog..

2) Add new Program/Configuration

3) Fill Name e.g. asdoc_files

4) Add Location of the asdoc executable (bin folder in your Flex Builder installation)

5) Add “Working Directory” by selecting your project from “Browse Workspace”

6) Add following arguments:
“-source-path “src”
-doc-sources .
-external-library-path=”libs” ”

It is of extreme importance that you should add external library path (as above) for any “SWC” that you have used in the project.

asdoc config

Categories: Quick Tip Tags:
  1. No comments yet.
  1. No trackbacks yet.