Javadoc is a standard and is very well documented.
You can buy books about Javadoc or just read the online documentation.
Try Google on Javadoc it will return just over 6.5 million references
The first one is
How to Write Doc Comments for the *Javadoc* Tool
<http://java.sun.com/j2se/javadoc/writingdoccomments/>"Official"
*JavaDoc* style guidelines from Sun Microsystems.
java.sun.com/j2se/*javadoc*/writingdoccomments/ - 87k - Cached
<http://72.14.207.104/search?q=cache:JR9iz3hP568J:java.sun.com/j2se/javadoc/writingdoccomments/+javadoc&hl=en&client=firefox-a>
- Similar pages
<http://www.google.ca/search?hl=en&hs=7AG&lr=&client=firefox-a&rls=org.mozilla:en-US:official_s&q=related:java.sun.com/j2se/javadoc/writingdoccomments/>
Home Page
<http://www.google.ca/url?sa=U&start=1&si=0&oi=smap&q=http://java.sun.com/&e=50073>
- Sun Microsystems
<http://www.google.ca/url?sa=U&start=1&si=1&oi=smap&q=http://www.sun.com/&e=50073>
The Java Tutorial
<http://www.google.ca/url?sa=U&start=1&si=2&oi=smap&q=http://java.sun.com/docs/books/tutorial/&e=50073>
- Java 2 Platform SE 5.0
<http://www.google.ca/url?sa=U&start=1&si=3&oi=smap&q=http://java.sun.com/j2se/1.5.0/docs/api/&e=50073>
More results from java.sun.com ยป
<http://www.google.ca/search?hl=en&hs=Qqa&lr=&client=firefox-a&rls=org.mozilla:en-US:official_s&q=+site:java.sun.com+javadoc>
This is an exellent start from the horse's mouth.
Ron
Martin Klasson wrote:
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
_______________________________________________
Flashcoders mailing list
[email protected]
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
