at.dms.compiler
Class JavadocComment

java.lang.Object
  extended by at.dms.compiler.JavaStyleComment
      extended by at.dms.compiler.JavadocComment
All Implemented Interfaces:
DeepCloneable, Serializable

public class JavadocComment
extends JavaStyleComment

A simple character constant

See Also:
Serialized Form

Field Summary
 
Fields inherited from class at.dms.compiler.JavaStyleComment
text
 
Constructor Summary
protected JavadocComment()
           
  JavadocComment(String text, boolean spaceBefore, boolean spaceAfter)
          Construct a node in the parsing tree
 
Method Summary
 Object deepClone()
          Returns a deep clone of this object.
protected  void deepCloneInto(JavadocComment other)
          Clones all fields of this into
 String getParams()
           
 boolean isDeprecated()
          Return if this javadoc comment contains a deprecated clause
 
Methods inherited from class at.dms.compiler.JavaStyleComment
deepCloneInto, getText, hadSpaceAfter, hadSpaceBefore, isLineComment
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocComment

protected JavadocComment()

JavadocComment

public JavadocComment(String text,
                      boolean spaceBefore,
                      boolean spaceAfter)
Construct a node in the parsing tree

Parameters:
text - the string representation of this comment
Method Detail

isDeprecated

public boolean isDeprecated()
Return if this javadoc comment contains a deprecated clause


getParams

public String getParams()

deepClone

public Object deepClone()
Returns a deep clone of this object.

Specified by:
deepClone in interface DeepCloneable
Overrides:
deepClone in class JavaStyleComment

deepCloneInto

protected void deepCloneInto(JavadocComment other)
Clones all fields of this into
other