### ASDocGen - Documentation Generator UI

#### Description

ASDocGen is a generic ActionScript documentation generator user interface for AS2API and ASDoc. It makes it easy to generate documentation from ActionScript code and you can save the documentation parameters as a project. Both tools use a JavaDoc type documentation syntax so it's easy to start producing high quality documentation with ASDocGen.

#### Usage

ASDoc has only one type of project (*.docproj) and it parses the arguments based on the compiler. The only difference between the two is the usage of the "Packages" / "Exclude classes" and the "Classpaths" fields. AS2API looks for the classpaths for the specified packages to be documented. You can list packages indivially or use a wildcard "*". (ie. com.company.package or com.company.*). The list should be space separated. ASDoc documents directly the specified classpaths and you can use the "Exclude classes" field to exclude classes from being documented. You can also import settings from AS2 Project or AS3 Project using "Import Project".

##### Explanation of arguments:

- Page title - The global page title of the documentation.
- Packages/Exclude classes - List of packages (AS2API) or classes to exclude (ASDoc).
- Output directory - The target directory where the documentation will be generated.
- Classpaths - The paths to the classes for the compiler. Default classes are added automaticly.
- Extra options - Additional options for the selected compiler. See Advanced for details.
- Compiler - The selected compiler. You need to define ASDoc location to the settings.

#### Settings

In the settings you can define the location of the compilers. AS2API is already set but you can change it if you want to use a custom version. ASDoc compiler needs to be defined so that you can use it. It is part of the free Flex SDK. You can use the "Copy compiler related template files" setting to use custom files (ie. css styles or other files) to be copied to the output directory. You need to place the files to ASDocGen/Files directory and each filename should start with a compiler name and a slash (ie. as2api-styles.css). This tells to the ASDocGen which files are for which compiler. The files will be copied everytime you compile the documentation.

##### Explanation of settings:

- AS2API location - The directory where the AS2API compiler resides. Defaults to ASDocGen/Tools.
- ASDoc location - The directory where the ASDoc compiler resides. This needs to be defined.
- Copy compiler related template files - After compile, copies the files to the output dir.

Advanced

Detailed help, syntax and command line argument lists can be found from the these locations:

- AS2API by David Holroyd
- ASDoc by Adobe Systems Incorporated