|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
java.lang.String getDocComment()
getDescriptionString()
or
getDocumentation()
instead.
void setDocComment(java.lang.String text)
setDescription(String)
or
getDocumentation()
instead.
SyntaxException
- if the given text contains an end-of-comment
markerjava.lang.String getDescriptionString()
This method is a shortcut for
getDocumentation().getDescriptionString()
.
DocComment.getDescriptionString()
void setDescription(java.lang.String description)
This method is a shortcut for
getDocumentation().setDescription(description)
.
SyntaxException
- if the given text contains an end-of-comment
marker, or a tagged-paragraphDocComment.setDescriptionString(String)
DocComment getDocumentation()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |