Talk:ASDoc:Creating ASDoc Comments
From Adobe Labs
ActionScript 2.0
So... will ASDoc work with ActionScript 2.0 classes and interfaces...?
JasonM23 13:39, 14 Aug 2006 (PDT)
No, ASDoc does not work with ActionScript 2.0. It uses the Flex 2 compiler infastructure, which only supports ActionScript 3. Sorry if this isn't clear on the page.
bdeitte 15:05, 14 Aug 2006 (PDT)
Double-byte characters wanted
Just want to say I love ASDocs (despite the bugs, erg). When are you guys going to get it to support UTF-8 characters? Someone on another Flex team found a way to use Ant and .jsp to convert the characters so that they appear in the final html output properly but I am not an Ant expert and would really like to use characters other than Ascii.
jpwrunyan 17:30, 15 Nov 2006 (PDT)
I think we'll be supporting double-byte in 2.0.1 which releases early next year.
matt_chotin 18:00, 20 Nov 2006 (EST)
Unmeaningful Exceptions
Not directed at the ASDoc developers personally, but what is it about Java API developers that make them so reticent to tell you what it was, exactly, that caused an exception?
[exec] An unexpected error occurred.
[exec] Error #1095: XML parser failure: Unterminated attribute.
[exec] (Location of error unknown)XSLT Error (javax.xml.transform.TransformerException): java.io.FileNotFoundException: C:\svn\StudyOptimizer\trunk\ganesh\docs\asdoc-temp\toplevel_classes.xml (The system cannot find the file specified)
[exec] Result: -1
Apparently there's an unterminated attribute... somewhere... in some XML file. Would it have killed the authors of ASDoc, XDoclet, SAX or whatever it was to say what attribute was unterminated, where it was and in what file? Because I just spend four hours being a good little programmer and updating all my docs, and now no one can benefit from the fruits of my labor.
You guys have any plans to open source this along with mxmlc?
Update: 1 hour later...
The difference between success and failure? For heaven's sake, don't use <code/> in your @see text description.
This causes the failure I received above:
* @see com.foo.service.impl.AbstractService for a reference implementation of <code>IService</code>
This succeeds
* @see com.foo.service.impl.AbstractService for a reference implementation of IService
Goodness knows why.
cluebcke 13:51, 4 Jun 2007 (PDT)
Related:
The comment:
/** @see "oops can't document this." */
will also cause the same exception -- spent for ever tracking down why my docs stopped working -- but, in my case, the single quote tick was the culprit.
ionous 11:29, 21 Sep 2007 (PDT)
