|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocTag
A 'block' tag within a DocComment
.
The start of a block tag is indicated within the comment by an '@'-prefixed word appearing at the start of a line (ignoring optional leading whitespace and '*' characters).
For example the following comment includes a 'see' block tag:
/* * Good. * @see MyClass */
If this text is not the first thing on the line, it is not interpreted as a block tag. Here, '@see' will just be interpreted as part of the description text, and metaas will not generate a DocTag for it:
/* * Bad. @see MyClass */
DocComment.addParaTag(String, String)
,
DocComment.delete(DocTag)
,
DocComment.findFirstTag(String)
,
DocComment.findTags(String)
Method Summary | |
---|---|
java.lang.String |
getBodyString()
|
java.lang.String |
getName()
|
void |
setBody(java.lang.String text)
|
void |
setName(java.lang.String name)
|
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
java.lang.String getBodyString()
void setBody(java.lang.String text)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |