uk.co.badgersinfoil.metaas.dom
Interface Documentable

All Known Subinterfaces:
ASClassType, ASField, ASInterfaceType, ASMember, ASMethod, ASType

public interface Documentable

Interface for parts of the ActionScript source code which can have API documentation comments attached. [Hopefully this interface will be extended to allow more sophisticated JavaDoc-style comment processing.]


Method Summary
 java.lang.String getDocComment()
          Returns the contents of the documentation comment for this API element.
 void setDocComment(java.lang.String text)
          Set the contents of the 'documentation comment' for this ActionScript API element.
 

Method Detail

getDocComment

java.lang.String getDocComment()
Returns the contents of the documentation comment for this API element. Lines of text in the comment will alreeady have had leading '*' characters removed. If there is no current documentation comment, null will be returned.


setDocComment

void setDocComment(java.lang.String text)
Set the contents of the 'documentation comment' for this ActionScript API element. If the given text has multiple lines, each line will have initial indentation and a '*' character added, so you shouldn't include these in the text yourself. Supplying a null value removes any existing comment.



Copyright © 2006-2007 David Holroyd. All Rights Reserved.