recoder.java
Class DocComment

java.lang.Object
  recoder.java.JavaSourceElement
      recoder.java.Comment
          recoder.java.DocComment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SourceElement

public class DocComment
extends Comment

Contains tags with

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface recoder.java.SourceElement

SourceElement.Position

Field Summary

Fields inherited from class recoder.java.JavaSourceElement

factory

Constructor Summary

	DocComment() Doc comment.
protected	DocComment(DocComment proto) Doc comment.
	DocComment(java.lang.String text) Doc comment.

Method Summary

void	accept(SourceVisitor v) Receive a visitor, for instance a pretty printer.
TagInfo	createTagInfo() Factory method that creates a tag info object that can analyze this comment.
DocComment	deepClone() Deep clone.

Methods inherited from class recoder.java.Comment

getParent, getText, isContainerComment, isPrefixed, setContainerComment, setParent, setPrefixed, setText, toString

Methods inherited from class recoder.java.JavaSourceElement

getEndPosition, getFactory, getFirstElement, getLastElement, getRelativePosition, getStartPosition, setEndPosition, setRelativePosition, setStartPosition, toSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocComment

public DocComment()

Doc comment.

DocComment

public DocComment(java.lang.String text)

Doc comment.

Parameters:

text - a string.

DocComment

protected DocComment(DocComment proto)

Doc comment.

Parameters:

proto - a doc comment.

Method Detail

deepClone

public DocComment deepClone()

Deep clone.

Specified by:

deepClone in interface SourceElement

Overrides:

deepClone in class Comment

Returns:

the object.

createTagInfo

public TagInfo createTagInfo()

Factory method that creates a tag info object that can analyze this comment.

Returns:

a tag info object describing the tags in this comment.

See Also:

TagInfo

accept

public void accept(SourceVisitor v)

Description copied from interface: SourceElement

Receive a visitor, for instance a pretty printer.

Specified by:

accept in interface SourceElement

Overrides:

accept in class Comment

Parameters:

v - a source visitor.