net.sourceforge.jenesis4java

Interface DocumentationComment

All Superinterfaces:

Codeable, Comment

public interface DocumentationComment
extends Comment

Comment subinterface for documentation comments (javadoc).

Field Summary

Fields inherited from interface net.sourceforge.jenesis4java.Comment

BLOCK_WITHOUT_INTERMEDIARY_STARS, D, DOCUMENTATION, M, Mbe, MULTI_LINE, S, SINGLE_LINE, TRAILING

Method Summary

Methods

Modifier and Type	Method and Description
DocumentationComment	addParam(String s) Adds a param tag to the list of param tags.
DocumentationComment	addSee(String s) Adds a see tag to the list of see tags.
String	getAuthor() Returns the author tag.
String	getDate() Returns the date tag.
String	getDeprecated() Returns the deprecated tag.
String	getException() Returns the exception tag.
List<String>	getParams() Returns an List of String over the list of param tags.
String	getReturn() Returns the return tag.
List<String>	getSees() Returns an List of String over the list of see tags.
String	getSerial() Returns the serial tag.
String	getSerialData() Returns the serialData tag.
String	getSerialField() Returns the serialField tag.
String	getSince() Returns the since tag.
String	getThrows() Returns the throws tag.
String	getVersion() Returns the version tag.
DocumentationComment	setAuthor(String s) Sets the author tag.
DocumentationComment	setDate(String s) Sets the datew tag.
DocumentationComment	setDeprecated(String s) Sets the deprecated tag.
DocumentationComment	setException(String s) Sets the exception tag.
DocumentationComment	setReturn(String s) Sets the return tag.
DocumentationComment	setSerial(String s) Sets the serial tag.
DocumentationComment	setSerialData(String s) Sets the serialData tag.
DocumentationComment	setSerialField(String s) Sets the serialField tag.
DocumentationComment	setSince(String s) Sets the since tag.
DocumentationComment	setThrows(String s) Sets the throws tag.
DocumentationComment	setVersion(String s) Sets the version tag.

Methods inherited from interface net.sourceforge.jenesis4java.Comment

getText, getType, setText, type

Methods inherited from interface net.sourceforge.jenesis4java.Codeable

applyStyle, cast, getComment, isActive, isBlockWithAbruptCompletion, setComment, toCode, visit, vm

Method Detail

addParam

DocumentationComment addParam(String s)

Adds a param tag to the list of param tags.

addSee

DocumentationComment addSee(String s)

Adds a see tag to the list of see tags.

getAuthor

String getAuthor()

Returns the author tag.

getDate

String getDate()

Returns the date tag.

getDeprecated

String getDeprecated()

Returns the deprecated tag.

getException

String getException()

Returns the exception tag.

getParams

List<String> getParams()

Returns an List of String over the list of param tags.

getReturn

String getReturn()

Returns the return tag.

getSees

List<String> getSees()

Returns an List of String over the list of see tags.

getSerial

String getSerial()

Returns the serial tag.

getSerialData

String getSerialData()

Returns the serialData tag.

getSerialField

String getSerialField()

Returns the serialField tag.

getSince

String getSince()

Returns the since tag.

getThrows

String getThrows()

Returns the throws tag.

getVersion

String getVersion()

Returns the version tag.

setAuthor

DocumentationComment setAuthor(String s)

Sets the author tag.

setDate

DocumentationComment setDate(String s)

Sets the datew tag.

setDeprecated

DocumentationComment setDeprecated(String s)

Sets the deprecated tag.

setException

DocumentationComment setException(String s)

Sets the exception tag.

setReturn

DocumentationComment setReturn(String s)

Sets the return tag.

setSerial

DocumentationComment setSerial(String s)

Sets the serial tag.

setSerialData

DocumentationComment setSerialData(String s)

Sets the serialData tag.

setSerialField

DocumentationComment setSerialField(String s)

Sets the serialField tag.

setSince

DocumentationComment setSince(String s)

Sets the since tag.

setThrows

DocumentationComment setThrows(String s)

Sets the throws tag.

setVersion

DocumentationComment setVersion(String s)

Sets the version tag.