Also there are questions on how to demonstrate examples of the methods.
Should this also be in the description?

I have seen some javaDoc-tools that generates documents, that they have
added own tags for certain things.

It isn't really that much of javaDoc-tags that are available.
As for instance @example would have been something I need and so on.

If I choose to use a certain application to generate my html-documents,
then I will have to conform to that applications tag-features -if it so
has some own tags as @example and others that isn't a part of the
javaDoc.

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

I guess there should be hands-on articles about this in the
flash-community, but I can not find them.

/ martin

-----Original Message-----
From: [EMAIL PROTECTED]
[mailto:[EMAIL PROTECTED] On Behalf Of Martin
Klasson
Sent: den 1 november 2005 08:51
To: Flashcoders mailing list
Subject: [Flashcoders] EventDispatcher and JavaDoc


I have read through several JavaDocs-documents and am still not having
any clue about how to write down that a method uses dispatchEvent.

class A{

        public function addToQueue(){
                // code..
                // dispatchEvent(...)
        }
}


Is there any @anything for dealing with how to write down the
dispatchEvent.
Or I will write it down in description, not that nice -but will work of
course.

Is there also some as2-class files that has some good usage of the
JavaDoc anywhere? Would be fun to see how JavaDoc is used within the
flash-community.

/ martin
_______________________________________________
Flashcoders mailing list
[email protected]
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
_______________________________________________
Flashcoders mailing list
[email protected]
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders

Reply via email to