Google failing me on an ASDoc question, every article references how to
document an event declared with a Metadata tag in the Flex framework, but not
how to document that a regular old Flash AS3 class dispatches a certain event.
I'm using FlashDevelop which is tied into the Flex 3 SDK's ASDoc and I've tried
all kinds of @eventType declarations. How is this done? I want to add info
that my class dispatches events MyEvent.ON_WHATEVER1, MyEvent.ON_WHATEVER2, and
MyEvent.ON_WHATEVER3 etc. like you see in the help docs. Have everything else
working that I need with ASDoc.
For example, I see a lot of examples like this:
/**
* Dispatched when the user presses the Button control.
* If the <code>autoRepeat</code> property is <code>true</code>,
* this event is dispatched repeatedly as long as the button stays down.
*
* @eventType mx.events.FlexEvent.BUTTON_DOWN
*/
[Event(name="buttonDown", type="mx.events.FlexEvent")]
But nothing on how to document this event using ASdoc:
private function something():void
{
dispatchEvent(MyEvent.ON_WHATEVER1);
}
One of the things I tried was this:
/**
* @eventType XMLFileLoaderEvent.LOAD_COMPLETE
*/
dispatchEvent(new
XMLFileLoaderEvent(XMLFileLoaderEvent.LOAD_COMPLETE));
But that failed in the method - also tried it in above the class declaration.
How do you handle this? Thanks,
Jason Merrill
Bank of America Global Learning
Learning & Performance Solutions
Join the Bank of America Flash Platform Community and visit our Instructional
Technology Design Blog
(note: these are for Bank of America employees only)
_______________________________________________
Flashcoders mailing list
[email protected]
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders