org.inxar.jenesis
Interface DocumentationComment

All Superinterfaces:
Codeable, Comment

public interface DocumentationComment
extends Comment

Comment subinterface for documentation comments (javadoc).


Fields inherited from interface org.inxar.jenesis.Comment
D, M, S
 
Method Summary
 void addParam(java.lang.String s)
          Adds a param tag to the list of param tags.
 void addSee(java.lang.String s)
          Adds a see tag to the list of see tags.
 java.lang.String getAuthor()
          Returns the author tag.
 java.lang.String getDate()
          Returns the date tag.
 java.lang.String getDeprecated()
          Returns the deprecated tag.
 java.lang.String getException()
          Returns the exception tag.
 Iterator getParams()
          Returns an Iterator of String over the list of param tags.
 java.lang.String getReturn()
          Returns the return tag.
 Iterator getSees()
          Returns an Iterator of String over the list of see tags.
 java.lang.String getSerial()
          Returns the serial tag.
 java.lang.String getSerialData()
          Returns the serialData tag.
 java.lang.String getSerialField()
          Returns the serialField tag.
 java.lang.String getSince()
          Returns the since tag.
 java.lang.String getThrows()
          Returns the throws tag.
 java.lang.String getVersion()
          Returns the version tag.
 void setAuthor(java.lang.String s)
          Sets the author tag.
 void setDate(java.lang.String s)
          Sets the datew tag.
 void setDeprecated(java.lang.String s)
          Sets the deprecated tag.
 void setException(java.lang.String s)
          Sets the exception tag.
 void setReturn(java.lang.String s)
          Sets the return tag.
 void setSerial(java.lang.String s)
          Sets the serial tag.
 void setSerialData(java.lang.String s)
          Sets the serialData tag.
 void setSerialField(java.lang.String s)
          Sets the serialField tag.
 void setSince(java.lang.String s)
          Sets the since tag.
 void setThrows(java.lang.String s)
          Sets the throws tag.
 void setVersion(java.lang.String s)
          Sets the version tag.
 
Methods inherited from interface org.inxar.jenesis.Comment
getText, setText, type
 
Methods inherited from interface org.inxar.jenesis.Codeable
getComment, setComment, toCode, vm
 

Method Detail

setAuthor

public void setAuthor(java.lang.String s)
Sets the author tag.

setDate

public void setDate(java.lang.String s)
Sets the datew tag.

setDeprecated

public void setDeprecated(java.lang.String s)
Sets the deprecated tag.

setException

public void setException(java.lang.String s)
Sets the exception tag.

setReturn

public void setReturn(java.lang.String s)
Sets the return tag.

setSerial

public void setSerial(java.lang.String s)
Sets the serial tag.

setSerialData

public void setSerialData(java.lang.String s)
Sets the serialData tag.

setSerialField

public void setSerialField(java.lang.String s)
Sets the serialField tag.

setSince

public void setSince(java.lang.String s)
Sets the since tag.

setThrows

public void setThrows(java.lang.String s)
Sets the throws tag.

setVersion

public void setVersion(java.lang.String s)
Sets the version tag.

getAuthor

public java.lang.String getAuthor()
Returns the author tag.

getDate

public java.lang.String getDate()
Returns the date tag.

getDeprecated

public java.lang.String getDeprecated()
Returns the deprecated tag.

getException

public java.lang.String getException()
Returns the exception tag.

getReturn

public java.lang.String getReturn()
Returns the return tag.

getSerial

public java.lang.String getSerial()
Returns the serial tag.

getSerialData

public java.lang.String getSerialData()
Returns the serialData tag.

getSerialField

public java.lang.String getSerialField()
Returns the serialField tag.

getSince

public java.lang.String getSince()
Returns the since tag.

getThrows

public java.lang.String getThrows()
Returns the throws tag.

getVersion

public java.lang.String getVersion()
Returns the version tag.

getParams

public Iterator getParams()
Returns an Iterator of String over the list of param tags.

addParam

public void addParam(java.lang.String s)
Adds a param tag to the list of param tags.

getSees

public Iterator getSees()
Returns an Iterator of String over the list of see tags.

addSee

public void addSee(java.lang.String s)
Adds a see tag to the list of see tags.