An integrated documentation solution for ActionScript 2 development

Mike recommended a Doxygen eclipse plugin(eclox) to me. After playing with it, I found it deadly easy to make up an integrated documentation solution in ActionScript 2 development in Eclipse.

Here is what I’ve got for my IDE

Figure above: code editing
 

Figure above: browsing documentation

How to make up this

1. Install Eclox for Eclipse
2. Create a .doxyfile in your opened project (File > New > Other > (Scroll to the bottom of the dialogue) > Other > Doxyfile)
3. Editor the doxyfile, make sure:
1. optimize results for Java
2. then in “Advanced” tab, set “File Patterns” to “*.as”
3. You may need to tweak other settings to make the output document nicer for ActionScript
4. Click the blue “@” button on the top tool bar
   
5. Done

To open the latest generated document, you can do:

1. In eclipse, press Ctrl+Shift+R open “Open Resource” dialogue
2. Enter “index.html”, and (if you got multiple items) pick the one in the documentation output folder
3. After the document is opened, click the “IE Preview” tab at the bottom of editor
   

More flavour for your documentation

A picture paints a thousand words. If you like diagram like me, go to get a free copy of dot generator and set it up in Doxygen like this: