undefined-type

A good thing when developing is to be able to generate code documentation for better overview and when sharing code for e.g. Open source or internal at your workplace.

With Flex you get the asdoc compiler, and by using Flex + ANT it’s simple to create some docs.

Make sure that you have ANT enabled and working.
1.) Open Flex Builder
2.) Help -> Software Updates -> Find and Install…
3.) Select: Search for new features to install
4.) Mark: “The Eclipse Project Updates” and click Finish. (url if needed)
5.) Expand the tree “Eclipse 3.3.2″ or newer.
6.) Find: “Eclipse Java Development Tools”, Mark and install.

Now you can create a new Actionscript or Flex project. Place the ANT XML file in project root file and run the “create_asdoc”, a new folder “docs” will be created and there is where you find your documentation.

Download ANT Script here.
For Windows users change the paths (C:/Program Files/Adobe/Flex Builder 3/sdks/3.0.0/bin/asdoc.exe)

Good links
ASDoc Tool
Example on how to document code

Flex actionscript, asdoc, documentation

This post is used for my course with the class “Webbh07″ at KY-Lindholmen/Gothenburg/Sweden. Welcome to their wonderful website.

I will post assignments, project files and the presentation material public for the class and for anyone that’s interested.
Read more…

Life education, speaker