Ant and ASDoc
by Ruben
After my personal little tragedy with ASDoc I started looking into some Ant scripts. After trying out a few yesterday (without any success) I decided I'd write my own.
At the hand of the Ant script made by Darron Schall and the one by Dave Williamson I put together my own.
If you're interested in using it, download it, and extract the two files in the zip to the bin folder of the project you'd like to generate documentation for.
Next, open the project. In the navigator, right click build.xml and select Run As » 1 Ant Build.
..and off you go, after the console (in the bottom of your Flex screen) says you're done, check out the asdoc folder (in bin).
However, before you go and try it out, please read through to the end of this post..
Note that if you've got your classes anywhere else than in (or below) com (as in com\rubenswieringa\MyClass.as) you should make a slight modification to the domainextensions property in the build.properties file.
Furthermore, in this file you can also customize the title of the documentation and the folder to which the docs will be outputted.
Also, apparently Ant support has to be enabled beforehand in a typical Flex installation, please read Peter Elst's post regarding this subject.
Please don't be shy and post a comment if you can't get it to work or got something else to ask/tell..
Comments (also 2 trackbacks, click to show)
Trackbacks:
I did some searching around and went through some of the same steps you’ve mentioned above and finally ( for now at least ) have it working on 2 macs. If anyone is interested here is a link to the process I went through:
http://squarefactor.com/words/2007/may/17/adobe-asdoc-mac/
Thank you very much Shawn, I’ll be sure to check it out again once I get the money together to buy myself a Mac
Is there just a really nice simple GUI that I can use?
If not, I would be interested in making one. Its pretty easy to run a command line app behind a C# GUI. I just don’t want to wast my time if it has already been done.
A few months ago I read something (can’t recall where
) about a plugin for Flex of which one of the features was a point-and-click interface for ASDoc generation..
If I remember this correctly, back then the plugin was still in the development phase, but I think it should have been released by now.
Also, I think you’ll have to pay for the plugin, but again, I’m not totally sure.
I’ll ask around at the office tomorrow. If you do decide to start working on a plugin then be sure to hit me up!
Hi, I have developed a desktop application using AIR. for generating AS Docs, i m using your code. but it gives me error as follows when i try to run it:
“Error: Unable to locate specified base class ‘mx.core.WindowedApplication’ for component class ‘testAIR’”
do i need to modify anything in build.xml to make it work for AIR app???
Waiting for your suggestions….
Thanks for the ant script.
I am using this, and am new, so may have made silly mistakes. The Ant is failing for mxml components that are extending other mxml components. The error indicates that it is unable to locate specified base class.
I know this is not an Ant issue but more of my configuration of asdoc.