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 Files\Adobe Flash Builder Beta\sdks\4.0.0\bin\asdoc.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!
 

Posted
AuthorPeter