Inside Out Outside In

MXML and ASDoc

I guess the ASDoc name says it all, as in ActionScript Documentation.  It doesn't really play well with MXML.  Unless you have a public var/function in an mx:Script block, you can't really document an MXML file.  I love ASDoc and it's been a real time saver for generating complete documentation with a simple command.

What I'd really like to see is a parameter added to the  base object class that would be ignored by the compiler but seen by ASDoc.  That way, MXML tags could be documented as well as being able to provide base class documentation for the MXML file itself, such as;

<mx:Application name="foo" xmlns:mx="http://www.adobe.com/2006/mxml" asdoc="This is the Foo Application" />


Comments (Comment Moderation is enabled. Your comment will not appear until approved.)
zwip's Gravatar It looks like your prayers are getting answered :)

http://www.adobeforums.com/webx/.59b687f8

"For adding comments at the class level or to properties defined inside mxml use the syntax <!--- comment (notice 3 dashes at the start) -->

Other tags supported in asdoc should also work. for example @see, @includeExamples etc."
# Posted By zwip | 9/20/08 6:59 AM