Category Archives: AS Docs

AS Docs

I am trying to figure out how to get AS Docs on my mac to work. I just spend the last four hours trying to get this working. I finally got it, and it seems like you need a “SRC” folder like what gets created when you have a flex project, but this is really for flash. I was able to figure this out from the command error, I guess I am learning after-all`-`

I am trying to document some actionscript 3.0 code, like that is seen in the adobe documentation.
Using terminal change location to the bin directory of the flex skd. The asDoc tool only seems to work from this location.

cd /Applications/Adobe Flex Builder 3/sdks/3.2.0/bin/
./asdoc -doc-sources=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/
-source-path=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/

The first line tells the complier where your application is, and the second line tells where you want the compiler to output your docs.

After running the application I get this nasty error

Loading configuration file /Applications/Adobe Flex Builder 3/sdks/3.2.0/frameworks/flex-config.xml
/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as: Error: A file found in a source-path must have the same package structure 'src', as the definition's package, ''.

/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/HelloWorld.mxml: Error: Can not resolve a multiname reference unambiguously. Greeter (from /Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as) and src:Greeter (from /Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as) are available.

/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/HelloWorld.mxml: Error: Can not resolve a multiname reference unambiguously. Greeter (from /Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as) and src:Greeter (from /Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as) are available.

/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/Greeter.as: Error: A file found in a source-path must have the same package structure 'src', as the definition's package, ''.

/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/HelloWorld.mxml(12):  Error: Type was not found or was not a compile-time constant: Greeter.

private var myGreeter:Greeter = new Greeter();

/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src/HelloWorld.mxml(12):  Error: Call to a possibly undefined method Greeter.

private var myGreeter:Greeter = new Greeter();

Now lets run this using the src folder structure that the AS Docs Tool wants

./asdoc -doc-sources=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src
-source-path=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src

Finally here is a link to my first AS Docs. Of course there are lots of problems with it, as I have to include certain code blocks in the actionsctipt file, but I am stoked that I finally got this working!

ASDoc in Flex Builder 3.2

I just recently found out that you can create AS Docs in Flex Builder, and here is how I set it up on my Mac OS X Environment.

Open Flex Builder.

Go to Run -> External Tools -> Open External Tools Dialog…

Step 1

Right click, or click on the page icon to create a new program. afterward select New

step 2

Afterwards you will get this window, which I already configured.

step 2

Lets just name our configure file in the Name field.

Name: MyASDocs (This can be anything that makes sense to you)

This is save the setting in the programs field. So you can just use Run MyASDocs

Next we want to browse to the asdoc executable file in the Flex Builder SDK. Click on Browse File System… under the Location field.

Location: /Applications/Adobe Flex Builder 3/sdks/3.2.0/bin/aasdoc

After that we need to use our library as the working directory. This will be where the project is located. Mine is in my home direcoty.

Working Directory: /Users/myUserName/HelloWorld (replace myUserName with your account name)

You can to add in your compiler options in the Arguments field.

Arguments: -source-path . -doc-sources ./ -window-title “HelloWorld” -main-title “My HelloWorld Greeter Package”

Note: the “./” is the current directory in UNIX writing(same as Mac OS X). You can also write the full path, which is the same as above in the “Working Directory” You can give it a window title, and the main title will be a title in the header of the html file. The docs will be written in HelloWorld in a folder called docs.

Click Apply, this will also save this perspective.

Click Run to generate the AS Docs.

Your documentation will be in /HelloWorld/docs The main file index.html will show you your docs.

Next I am hoping to find a more general solution, as this has to be changed each time your project changes, or you will need many different perspectives.

This is an incribale find, and I am stoked!

Happy Coding.

AS Docs Air App

Has anybody tried DITA for creating AS Docs?

I just downloaded it, but uploading some huge files, so I thought that I would ask?

Air App for AS Docs

ASDocs on Mac

I am trying to figure out how to get AS Docs on my mac to work. I just spend the last four hours trying to get this working. I finally got it, and it seems like you need a “SRC” folder like what gets created when you have a flex project, but this is really for flash. I was able to figure this out from the command error, I guess I am learning after-all`-`

I am trying to document some actionscript 3.0 code, like that is seen in the adobe documentation.
Using terminal change location to the bin directory of the flex skd. The asDoc tool only seems to work from this location.


cd /Applications/Adobe Flex Builder 3/sdks/3.2.0/bin/

./asdoc -doc-sources=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/

-source-path=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/

The first line tells the compiler where your application is, and the second line tells where you want the compiler to output your docs.

Now lets run this using the src folder structure that the AS Docs Tool wants


./asdoc -doc-sources=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src

-source-path=/Users/johnbarrett/Documents/Flex Builder 3/HelloWorld/src