asdoc

How can ASDoc Ant Task work without -source-path option?

I am tring to get the ASDoc Ant task to work: <target name="asdoc" depends="compile"> <mkdir dir="${dist_asdocs}"/> <asdoc docSources="${srcdir}" output="${dist_asdocs}" executable="${FLEX_HOME}/bin/asdoc.exe" /> </target> When I run it I get errors from ASDoc like "Error: Type was not found or was not a compile-time constant: X...

ASDoc through the Flex Builder UI?

Is there any way to run ASDoc on your project via the Flex Builder UI? Or, is there a good (preferably free) plugin that will do so? If there is no UI for it, does someone have a link to a tutorial on how to set it up to be automatic when I build my project, maybe via Ant (which I've never used, but am more than happy to try) or someth...

Where does ASDoc get its intrinsic class definitions from?

I mean that of the built-in ECMA objects: String, Number, Object, Function, RegExp, Error, Boolean, etc.. ...

Generating Warnings for Undocumented AS3 Members? (ASDoc)

I have a Flash (AS3) component library that I'm distributing, and I want to make sure that it's fully documented for each release. One of the things I really liked about Microsoft's automatic doc generation for C# was that I could have my compiler generate warnings (on every compile) for any public member that wasn't documented in their ...

Flex 3 ASDocs Library Issue

We've been attempting to compile ASDocs against a Flex 3 Library Project. Our problem is that ASDocs refuses to recognize any custom mxml component that is both created and used within the library. For example, if we have a custom mxml AdvancedButton control in our library, and we attempt to use it in another mxml class within the li...

Can ASDoc in Flex create documentation for packages/namespaces?

As the title says - is it possible to document my ActionScript packages / namespaces using the ASDoc comments and the included asdoc command line tool? ...

Fixing broken paths in ASDoc?

This question concerns using ASDoc to create documentation from AS3. I'm not doing this from Flex or anything, just using the command line, and though everything works fine and ASDoc doesn't return any errors, some of the links in the resulting documentation are broken. Specifically, in all the places where there are links to properties...

flex/ actionscript comments

cannot get the comments to show in actionscript file when running asdoc.. is this a known bug? [Bindable] /** test comment */ public var currentSearchTextValue:String; does not show anything in the generated documentation... am I doing something wrong? ...

Using ASDoc with Bindable metatag and mxml

I am creating the documentation of my flex project using ASDoc and having some issues with the bindable metatag. ASDoc doesn't document public Bindable values unless the Bindable tag has an event name associated with it. For example: //This is documented correctly [Bindable("someEvent")] /* * public bindable with event name * */ p...

custom pages using asdoc

Does anyone know if you can write your own pages that asdoc will recognize and use? For instance, I'd like to write some "Getting Started","Support" and "FAQ" kind of pages that will help understanding what my actionscript classes are about. ...

Hosting asdocs in a subfolder

I generated my asdocs just fine today. I wanted to host them on a public site: www.somethingoranother.com/asdocs. I put the asdocs folder in a subfolder of my server. In other words, my documentroot was here: /var/www/somethingoranother and I put the asdocs here: /var/www/somethingoranother/asdocs This broke the asdocs, becaus...

Documenting private members with ASDoc

Can ASDoc be set to document private members ala JavaDoc? ...

problems generating ASDoc

Hi I am using ASDocr, which is an Adobe AIR application GUI interface for the command-line Flex asdoc documentation generator. My class uses several external libraries and it is generating a 1046 error when creating the documentation: /Users/mga/Documents/FDT Workspace/vgline/src/com/pingpongestudio/timeline/Timeline.as(1569): col: 39 ...

ASDoc: is there any way to preprocess documentation?

I'd like to start using ASDoc to generate pretty HTML from my ActionScript code… But, coming from Python, I just can't stomach the idea of filling my asdoc comments with HTML. So, is there any way simple way to ask ASDoc to preprocess documentation comments? For example, so I can have a comment like this: /** * Return the maximum of s...

ASDoc ignores public function definitions?

I've got a collection of ActionScript utility functions… But when I try to run asdoc over them, they don't appear in the list of 'package functions'. For example, if I run: asdoc -doc-sources+=src/utils/ -doc-sources+=src/utils/map.as -doc-sources+=src/utils/max.as -source-path+="src" I don't see either the map function or the max fu...

How do I troubleshoot an "Error #1090" trying to generate ASDoc?

I've got a reasonably large Flex project and I'm trying to generate ASDoc documentation for it. When I run asdoc, it gives me this error: An unexpected error occurred. Error #1090: XML parser failure: element is malformed. (Location of error unknown)XSLT Error (javax.xml.transform.TransformerException): java.io.FileNotFoundException: ...

Does Flash CS4 have an alternative to ASDoc?

Does anybody know of a tool that will allow me to create ASDoc style documentation with a Flash CS4/AS3 application? From what I hear ASDoc only works with Flex. Thanks ...

How to force asdoc run in English

My operation system is Window XP in Chinese. I'm running flex sdk > asdoc in command line. Asdoc picks up the system default language. How can I force it to be run in English language environment? ...

Asdoc throwing errors for MXML component that includes a separate .as file.

I have an MXML component that includes a .as file with <fx:Script source="myfile.as" /> Running asdoc throws a whole bunch of errors like "Error: The private attribute may be used only on class property definitions." "Error: The public attribute can only be used inside a package." The only useful information I could find on the sub...

ASDoc compiling error in Flash Builder 4

I can't seem to figure out why i continue getting this error every-time I try to compile ASDoc in Flash Builder 4. I did succeed in ASDoc creating a asdoc-output folder but it is incomplete. There is only toplevel.xml and a tempdita folder that show up. This is the error that shows up on my Console Error at xsl:choose on line 46 of p...