uk.co.badgersinfoil.metaas.dom
Interface Documentable

All Known Subinterfaces:

ASClassType, ASField, ASInterfaceType, ASMember, ASMethod, ASType

public interface Documentable

Interface extended by ScriptElements which can have API documentation comments attached. The actual documentation itself is represented by an instance of DocComment, as produced by a Documentable object's getDocumentation() method.

Method Summary

java.lang.String	getDescriptionString() Returns the 'description' part of this documentation comment as a string.
java.lang.String	getDocComment() Deprecated. use getDescriptionString() or getDocumentation() instead.
DocComment	getDocumentation() Returns a reference to an object allowing manipulation of documentation associated with this Documentable API element.
void	setDescription(java.lang.String description) Defines the 'description' part of the documentation comment of this API element.
void	setDocComment(java.lang.String text) Deprecated. use setDescription(String) or getDocumentation() instead.

Method Detail

getDocComment

java.lang.String getDocComment()

Deprecated. use getDescriptionString() or getDocumentation() instead.

setDocComment

void setDocComment(java.lang.String text)

Deprecated. use setDescription(String) or getDocumentation() instead.

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.

Throws:

SyntaxException - if the given text contains an end-of-comment marker

getDescriptionString

java.lang.String getDescriptionString()

Returns the 'description' part of this documentation comment as a string. The description is the comment text from the start of the comment up to the first 'tagged paragraph'.

This method is a shortcut for getDocumentation().getDescriptionString().

See Also:

DocComment.getDescriptionString()

setDescription

void setDescription(java.lang.String description)

Defines the 'description' part of the documentation comment of this API element.

This method is a shortcut for getDocumentation().setDescription(description).

Throws:

SyntaxException - if the given text contains an end-of-comment marker, or a tagged-paragraph

See Also:

DocComment.setDescriptionString(String)

getDocumentation

DocComment getDocumentation()

Returns a reference to an object allowing manipulation of documentation associated with this Documentable API element. If there is currently no documentation available, this method will return an 'empty' object, but modifications to that object will cause a documentation-comment to be created in the source code.