Re: [flexcoders] Question about flex source

2010-01-04 Thread Aaron Hardy
See here under asdoc tags:
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_1.html

The @eventType tells the ASDoc generator that what it's seeing on that line
is something special and needs to be dealt with in a special way.  It
shouldn't affect your application's code execution in any way.  I'm not from
Adobe though so my response is nothing official...it's just what I've
gathered from experience.

Aaron

On Sun, Jan 3, 2010 at 7:55 PM, ztpi1 zt...@yahoo.com wrote:



 I notice that the flex source files have commented out sections like this
 one:

 **
 * Dispatched after the Application has been initialized,
 * processed by the LayoutManager, and attached to the display list.
 *
 * @eventType mx.events.FlexEvent.APPLICATION_COMPLETE
 */

 Is the @ symbol significant here? Does the compiler see the line with the @
 symbol or is it merely for reader information?

 It is my understanding that the @ symbol denotes an XML attribute, is that
 the correct interpretation?

  



RE: [flexcoders] Question about flex source

2010-01-04 Thread Gordon Smith
Aaron is correct. The AS/MXML compiler ignores comments, and the @ in 
@eventType has nothing to do with an XML attribute (although this is what it 
would indicate if it were in AS code rather than in a comment). However, the 
ASDoc generator pays attention to all comments that start with /**, and does 
special processing on attributes like @eventType, @param, and @result inside 
these comments. We adopted this convention from how JavaDoc works.

Gordon Smith
Adobe Flex SDK Team

From: flexcoders@yahoogroups.com [mailto:flexcod...@yahoogroups.com] On Behalf 
Of Aaron Hardy
Sent: Monday, January 04, 2010 7:31 AM
To: flexcoders@yahoogroups.com
Subject: Re: [flexcoders] Question about flex source



See here under asdoc tags: 
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_1.html

The @eventType tells the ASDoc generator that what it's seeing on that line is 
something special and needs to be dealt with in a special way.  It shouldn't 
affect your application's code execution in any way.  I'm not from Adobe though 
so my response is nothing official...it's just what I've gathered from 
experience.

Aaron
On Sun, Jan 3, 2010 at 7:55 PM, ztpi1 zt...@yahoo.commailto:zt...@yahoo.com 
wrote:


I notice that the flex source files have commented out sections like this one:

**
* Dispatched after the Application has been initialized,
* processed by the LayoutManager, and attached to the display list.
*
* @eventType mx.events.FlexEvent.APPLICATION_COMPLETE
*/

Is the @ symbol significant here? Does the compiler see the line with the @ 
symbol or is it merely for reader information?

It is my understanding that the @ symbol denotes an XML attribute, is that the 
correct interpretation?