ConForM.CoopnTools.CoKer.DocComment
Class DocComment

java.lang.Object
  |
  +--ConForM.CoopnTools.CoKer.DocComment.DocComment

public class DocComment
extends java.lang.Object

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

DocComment

public DocComment(java.lang.String summary,
                  java.lang.String description,
                  DocTag[] tags)
           throws java.lang.IllegalArgumentException
Constructor. Build a new doc comment.
Parameters:
summary - the summary; must be present
descr - the descr string. May be null.
tags - an array of tags. May be null.
Throws:
java.lang.IllegalArgumentException - the summary is absent, or the tags are inconsistent. (for instance, many version tags).
Method Detail

summary

public java.lang.String summary()
Get the summary.

hasDescription

public boolean hasDescription()
Test if the presence of a description.
Returns:
true iff this comment has a description.

description

public java.lang.String description()
Get the description.

tagNumber

public int tagNumber()
Get the number of tags.

seeTagNumber

public int seeTagNumber()
Get the number of see tags.

moreTagNumber

public int moreTagNumber()
Get the number of more tags.

authorTagNumber

public int authorTagNumber()
Get the number of author tags.

paramTagNumber

public int paramTagNumber()
Get the number of param tags.

hasTag

public boolean hasTag()
Test the presence of tags.

hasSeeTag

public boolean hasSeeTag()
Test the presence of see tags.

hasMoreTag

public boolean hasMoreTag()
Test the presence of more tags.

hasAuthorTag

public boolean hasAuthorTag()
Test the presence of author tags.

hasVersionTag

public boolean hasVersionTag()
Test the presence of version tags.

hasParamTag

public boolean hasParamTag()
Test the presence of param tags.

hasReturnTag

public boolean hasReturnTag()
Test the presence of return tags.