RE: [flexcoders] ASDoc for MXML components?

2007-06-07 Thread Stephen Gilson
There is only limited support in ASDoc for MXML files. 
 
- All ActionScript entities defined in an mx:Script block, such as
properties and methods, appear in the output. Items defined in MXML tags
do not appear in the ASDoc output. 

- You can only insert an ASDoc comment in an mx:Script block of an
MXML file. 

- The superclass corresponds to the first tag in the MXML file. For an
application file, that tag is the mx:Application tag and therefore an
MXML application file appears in the ASDoc output as a subclass of the
Application class.
 
Stephen



From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] On
Behalf Of borekbe
Sent: Thursday, June 07, 2007 10:42 AM
To: flexcoders@yahoogroups.com
Subject: [flexcoders] ASDoc for MXML components?



Hi all

Is there a way to generate API documentation from MXML components? So
far, I thought that MXML and ActionScript are just different ways to
express the same things but if I can't generate documentation, this
practically means that I can't use MXML for component development at
all. I hope it's not the case because MXML is much more suitable for
certain scenarios...

Thanks,
Borek



 


Re: [flexcoders] ASDoc for MXML components?

2007-06-07 Thread Daniel Freiman

It looks like the mx:Metadata tag might also allows for comments, but i
haven't personally confirmed that.  See RichTextEditor.mxml for what I'm
talking about.

Daniel Freiman
nondocs http://nondocs.blogspot.com


On 6/7/07, Stephen Gilson [EMAIL PROTECTED] wrote:


   There is only limited support in ASDoc for MXML files.

- All ActionScript entities defined in an mx:Script block, such as
properties and methods, appear in the output. Items defined in MXML tags do
not appear in the ASDoc output.
- You can only insert an ASDoc comment in an mx:Script block of an MXML
file.
- The superclass corresponds to the first tag in the MXML file. For an
application file, that tag is the mx:Application tag and therefore an MXML
application file appears in the ASDoc output as a subclass of the
Application class.

Stephen

 --
*From:* flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] *On
Behalf Of *borekbe
*Sent:* Thursday, June 07, 2007 10:42 AM
*To:* flexcoders@yahoogroups.com
*Subject:* [flexcoders] ASDoc for MXML components?

 Hi all

Is there a way to generate API documentation from MXML components? So
far, I thought that MXML and ActionScript are just different ways to
express the same things but if I can't generate documentation, this
practically means that I can't use MXML for component development at
all. I hope it's not the case because MXML is much more suitable for
certain scenarios...

Thanks,
Borek