Javadoc is used in Actionscript the same way as it is in any language.
Here is a partial fragment showing the use of some of the possible tags.
It shows single- and multi-line comments
import com.artifact_software.ali.common.ALIBaseObject;
/** Text Object holds info for making a TextFormat
*
* Keeps all information about the visual aspects of text
* @author David Dyer
* @author Ron Wheeler
* @version 1.1
* @since 1.0
*/
class com.artifact_software.ali.common.TextObject extends ALIBaseObject
{
var textText:String; /**<text contents */
var textFont:String; /**< name of the font */
var textFontSize:Number; /**< font size */
/**! Constructor
*
* @param textXMLNode is the XML node with attributes that describe the
text' appearance
*
*/
function TextObject(textXMLNode:XMLNode)
{
this.setObjectType("TextObject");
this.setVersion("1.1");
}
public function getText():String {return this.textText;} /**< Returns
the textstring*/
public function getFont():String {return this.textFont;} /**< Returns
the Font Name*/
public function getFontSize():Number {return this.textFontSize;} /**<
Returns Size of the font*/
}
This is all done inside Eclipse so it is trivial to recreate the
documentation with eclox and Doxygen.
Does this help?
Ron
Martin Klasson wrote:
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
