|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--ConForM.CoopnTools.CoKer.DocComment.DocComment
Documentation Comment. This class defines documentation comments, which are composed of a summary string, a description string, and a set of doc tags. This class must be considered as delivering immutable objects
Constructor Summary | |
DocComment(java.lang.String summary,
java.lang.String description,
DocTag[] tags)
Constructor. |
Method Summary | |
int |
authorTagNumber()
Get the number of author tags. |
java.lang.String |
description()
Get the description. |
boolean |
hasAuthorTag()
Test the presence of author tags. |
boolean |
hasDescription()
Test if the presence of a description. |
boolean |
hasMoreTag()
Test the presence of more tags. |
boolean |
hasParamTag()
Test the presence of param tags. |
boolean |
hasReturnTag()
Test the presence of return tags. |
boolean |
hasSeeTag()
Test the presence of see tags. |
boolean |
hasTag()
Test the presence of tags. |
boolean |
hasVersionTag()
Test the presence of version tags. |
int |
moreTagNumber()
Get the number of more tags. |
int |
paramTagNumber()
Get the number of param tags. |
int |
seeTagNumber()
Get the number of see tags. |
java.lang.String |
summary()
Get the summary. |
int |
tagNumber()
Get the number of tags. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DocComment(java.lang.String summary, java.lang.String description, DocTag[] tags) throws java.lang.IllegalArgumentException
summary
- the summary; must be presentdescr
- the descr string. May be null.tags
- an array of tags. May be null.java.lang.IllegalArgumentException
- the summary is absent, or the tags are inconsistent.
(for instance, many version tags).Method Detail |
public java.lang.String summary()
public boolean hasDescription()
public java.lang.String description()
public int tagNumber()
public int seeTagNumber()
public int moreTagNumber()
public int authorTagNumber()
public int paramTagNumber()
public boolean hasTag()
public boolean hasSeeTag()
public boolean hasMoreTag()
public boolean hasAuthorTag()
public boolean hasVersionTag()
public boolean hasParamTag()
public boolean hasReturnTag()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |