AS2Doc - FAQ: Frequently Asked Questions

AS2Doc Tags

FAQ

Documentation

Contact

Support > FAQ

Overview:

- What is AS2Doc?
- Can I use AS2Doc with parameters from the command-line?
- Can I create my own documentation styles?
- Why can I only select one class file (no classpath)?
- Does AS2Doc support Chinese or Japanese (Unicode) characters?
- AS2Doc seems unable to find the "styles" directory, but you are sure it exists.
- Do you offer discount for upgrades to a site-license if I bought single-licenses?
- Do you target to support ActionScript 3.0?
- How do I upgrade my current version to the latest?
- Events? Recommendations and future support?

What is AS2Doc?
Friday, February 27, 2004

AS2Doc is a documentation generator. It reads your ActionScript 2 based sourcecode and analyzes your comments and code. Information gathered from that process is then used to output a detailed and powerful documentation for your code.

Can I use AS2Doc with parameters from the command-line?
Friday, February 27, 2004

Yes. You can even supply a saved project information file so there is no need to add more options. Open AS2Doc once to open the user interface, configure your project settings, save them and use: "as2doc.exe myproject.xml to let AS2Doc generate the documentation on your settings automatically.

Can I create my own documentation styles?
Tuesday, March 9, 2004

Simply, yes. Alongside with the standard styles we also provide you with a "template XSL style" which you can use to build your own style.
Look inside the subdirectory "styles" in your AS2Doc installation directory. The file to start with is called "styles.xsl" and is well-documented.

Also check out our Styles Section for new styles to download!

Why can I only select one class file (no classpath)?
Thursday, March 25, 2004

This is a limitation of the trial edition. The full version enables you to select a classpath or single class to be used for generation. Using the GUI, you can configure which classes should be generated in the final output.

Does AS2Doc support Chinese or Japanese (Unicode) characters?
Tuesday, October 26, 2004

Yes, AS2Doc supports all characters available for the input encoding UTF-8 as used for Flash ActionScript sources. The output styles have special processing included to enable correct encoding within the output formats. The program interface is Unicode aware.

AS2Doc seems unable to find the "styles" directory, but you are sure it exists.
Saturday, November 27, 2004

Make sure you have installed the MSXML v3 Library which is available here.

Do you offer discount for upgrades to a site-license if I bought single-licenses?
Tuesday, May 10, 2005

Yes, we offer discounts if you upgrade to a site-wide license and have purchased single-licenses before. Please contact us for this matter here.

Do you target to support ActionScript 3.0?
Thursday, January 19, 2006

We are not currently implementing direct support for ActionScript 3.0. However, we are rewriting parts of the parsing process in order to be modular and allow for extension for different ActionScript versions such as AS1 and AS3. Once this is done in one of the next updates we will be able to provide information on future support regarding AS3.

How do I upgrade my current version to the latest?
Thursday, January 19, 2006

Simply download the updater from here. Once started it will update your copy of AS2Doc to the latest version. We recommend you to use the latest version before submitting reports.

Events? Recommendations and future support?
Thursday, January 26, 2006

As of yet, despite requested, we have not implemented a specific event listing as there are different views/definitions upon what is classified as an "event" in Flash (fields, functions, [Event] Metadata, Flash Property based Events, Parameter Events, EventListeners...).

Note that we are most likely going to add a solution to the various "event" support approaches in one of the next updates which will be based on introducing the @event tag officially since it is one of the most requested features.

We recommend those who ask to implement use of an @event doctag within their XSL Styles for now in order to define which members correspond to events (Such as certain fields "var onReceive:Function").