ASDoc generation in Flex
by Ruben
Yay and boo. Yay because ASDoc comes with the Flex installation. Boo because it's command-line, what is that?
To top it off, you can't have spaces in the sourcepath's value, not even as nobrakingspaces ( ) or when urlencoded (%20).
Here's an example:[code]asdoc -source-path C:\asdoc_temp -doc-classes com.rubenswieringa.CSSLoader com.rubenswieringa.CSSParser -main-title "CSSLoader documentation" -window-title "CSSLoader documentation" -output asdoc-output-temp[/code]You'll be able to grab the output-files from the Flex SDK 2\bin\asdoc-output-temp folder in your Flex installation folder. Thanks to Ids for helping me out, the commandline-noob that I am.
I have written an Ant script to simplify the process of generating ASDocs.
For the sake of clearity I've seperated it from this post. See the post on Ant and ASDoc.
Comments (also 2 trackbacks, click to show)
Trackbacks:
you can wrap your file reference in quotations and the command line utility should work just fine. no need to create an ANT task…unless you want to, of course.
Well that’s the thing really, in my opinion commandline isn’t really user-friendly..
did you try doing this:
“C:\asdoc_temp -doc-classes”
it might help you get around the space issue in your source path…
Hey, well actually I got frustrated by the commandline-thing pretty soon after my first attempt, so I put together a little ANT-script of my own:
rubenswieringa.com/blog/ant-and-asdoc
Use quotes around the path like:
asdoc -source-path “C:\Stupid OS with spaces in path\but whatcha gonna do\”
-=Cliff>
I could be wrong, but doesn’t the usage of quotes allow you to have spaces in your sourcepath? eg asdoc -source-path “C:\Program Files\asdoc” …