Flash Builder 4 beta – exporting ASDoc documentation

Despite the excellent ASDoc integration added in Flash Builder 4 beta, it seems its still not easy to export to HTML and you need to set it up yourself using an external tool configuration.

I spent some time trying to figure it out and stumbled across a post by Seb Lee-Delisle that gives a good runthrough of how to set it up. Thought it would be useful to show how to set it up in Flash Builder 4 beta.

  • Go to Run > External Tools > External Tools Configurations
  • Select Program (left sidebar) and click the New button to create a new configuration
  • Give your configuration the name “ASDoc”
  • Set the location to “/Applications/Adobe Flash Builder Beta/sdks/4.0.0/bin/asdoc” (the default on Mac) on Windows the default is “C:Program FilesAdobe Flash Builder Betasdks4.0.0binasdoc.exe”
     
  • For Working Directory you can set it to ${project_loc}, this is a variable that always point to the location of your current project
  • Finally you set up some arguments, assuming you put your code in the default “src” folder:
    -source-path src
    -doc-sources src
     
    Those arguments set your source directory and tell the ASDoc tool to recursively go through all classes in that folder and its subfolders and generate the documentation.

 

ASDoc setup
 

To run the ASDoc tool and export your documentation to HTML, select your project and click Run > External Tools > ASDoc. When its finished scanning your code and generating the documentation you’ll find it in a folder in your project called “asdoc-output”. Enjoy!

 

Advertisements

6 thoughts on “Flash Builder 4 beta – exporting ASDoc documentation

  1. It’s amazing that Adobe still hasn’t integrated AS Doc into a Run/Build for developers. As you mentioned there is some very nice AS Doc support when writing your code but you have to go through great lengths to actually get it to output. Thanks for the post…

  2. Mediamonkey says:

    Nice, thanks for the article.

  3. We use an ant script to handle the as-doc generation. Works like a charm. I agree that a built in system for documentation would be helpful. But what I really miss is a way to integrate my own documentation into the context help of Flash/Flex Builder/Eclipse so that shift+F2 could search within documentation for my own API.
    We license part of our API to third-party developers and this would make their work flow a lot smoother.

  4. cm says:

    thanks a bunch 🙂

  5. […] Flash Builder 4 beta – exporting ASDoc documentation | Peter Elst http://www.peterelst.com/blog/2009/06/08/flash-builder-4-beta-exporting-asdoc-documentation – view page – cached Flash Platform Consultant, Despite the excellent ASDoc integration added in Flash Builder 4 beta, it seems its still not easy to export to HTML and you need to set it up yourself using an — From the page […]

Comments are closed.

%d bloggers like this: