About the ZenDoc ActionScript Documenter

screenshot 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 determine the content of the documentation generated. For more on correctly commenting source files for ZenDoc, see Commenting Source Files for ZenDoc in the documentation. Note that ZenDoc works using a "consider only what's commented" approach to source code parsing meaning any code without Javadoc comments is ignored. This prevents the need to parse the entire source file keeping ZenDoc simple and efficient.

ZenDoc also gives you to control over the documentation content by way of HTML templates. These templates give you control over the style and layout of the documentation generated from source files. They follow conventions similar to those found in Dreamweaver making them easy to create and customize on your own. Learn more about templates in the ZenDoc Template Format section of the documentation.

Though ZenDoc can document many files at one time, each file is documented individually, so it works best when documenting single classes rather than entire packages or collections of classes which relate to each other. Documenting multiple files (local) requires access to the file system in which ZenDoc is installed. If you do not have access, you can still use ZenDoc's external documentation feature but would be limited to documenting one file at a time. In doing this, the generated documentation will pop up in a new window allowing you to save that page to a location on your hard drive through your web browser.

You can start using ZenDoc right now by going to http://www.zendoc.org/zendoc/ and accessing the web interface there. You also have the option of downloading ZenDoc to use on your own (see the downloads page).

For more detailed information on what ZenDoc can do and how to use it, visit the ZenDoc Manual.

Also see ZenDoc screenshots and ZenDoc documentation examples.