Getting ASDoc to recognize Adobe AIR classes

Now that AIR 1.0 is official, some people are having trouble getting the ASDoc utility that ships with Flex Builder 3 to recognize the new AIR classes. Here's a quick way to do it.

Use the -library-path option on the ASDoc command line to include the folder that contains the airframework.swc and airglobal.swc files. For example:

asdoc -source-path . -doc-classes myComponents.MyFileManager  -library-path+=..\frameworks\libs\air

Notice the += after in the -library-path value. That appends the location of the AIR SWC files to the default list, which includes the Flex Framework SWCs.

Of course you will also need to change the path to the \frameworks\libs\air folder relative to the location from which the asdoc utility is running.

Thanks go to Stephen Gilson of the Flex Learning Resources team for providing this information.

Comments

Or you can use the aasdoc command (note the extra "a"). This loads the air-config.xml file that includes the AIR libraries for you.

[Stephen Buckley]

Any idea what would produce the following error in ASdocs

An unexpected error occurred.
Error #1083: The prefix "see" for element "see:" is not bound.

[Davide Zanotti]

I solved using "-external-library-path"

Read here: http://www.daveoncode.com/2009/05/04/documenting-actionscript-classes-which-make-use-of-air-framework/

;)

[Edoardo Gusmaroli]

I solved found a "@see:" comment instead of "@see".