Categories
Articles

Adobe AsDoc -doc-sources

I was experimenting with the Adobe ASDoc tool. Adobe uses it for its on-line API documentation for Flex, Apollo and Actionscript.

In my case I had a com folder with my own domain, com.hosford. I also had com.otherDomains from various sources such as books I purchased where the author provided a library of code.

I wanted to create the docs for all of the com.hosford portion and not include other com.otherDomains. In fact I wanted to limit the docs to com.hosford.practice. This is a place for examples and experiments and future code snippets, a play area.

The folder layout is as follows:

com/hosford/practice/… various

apps/practice

In apps/practice is the command file for ASDocs. I wanted ASDocs to create a folder called Practice-Docs in apps/practice.

The ASDocs switch to use was -doc-sources. The command line in a Windows batch file worked out as follows (all on one line):

"C:\Program Files\Adobe\Flex Builder 2\Flex SDK 2\bin\asdoc.exe" "-doc-sources" "../../com/hosford/practice" "-main-title" "Practice API Documentation" "-window-title" "Practice API Documentation Window Title" "-output" "Practice-Documentation"

More information on ASDocs as follows:

ASDocs Documentation

ASDocs -doc-sources