[as2api-dev] Comments for getter/setter pairs
Luke Schreur
luke at back.net.au
Thu Mar 8 05:25:19 UTC 2007
Hi,
I was trying to add some documentation to my class this afternoon but I
got confused when I needed to comment a getter/setter pair. The as2api
documentation doesn't seem to give an example of this (at least not that
I can find) and the comments I put in don't not show up in the final
generated documentation. This is the structure I currently use:
Class MyClass
{
private var m_property : Type;
/**
* comments here.
*/
public function set property(property : Type) : Void
{
m_property = property;
}
public function get property() : Type
{
return( m_property );
}
}
Basically, what is the correct way to add the documentation for
'property' in this situation?
Thanks,
Luke
More information about the as2api-dev
mailing list