ConForM.CoopnTools.CoKer.DocComment
Class ReturnDocTag
java.lang.Object
|
+--ConForM.CoopnTools.CoKer.DocComment.DocTag
|
+--ConForM.CoopnTools.CoKer.DocComment.ReturnDocTag
- public class ReturnDocTag
- extends DocTag
Documentation Return Tag. Stores a return. Can only appear in
comments of CoopnSyntacticFunctionnalSymbol, once.
Constructor Summary |
ReturnDocTag(java.lang.String meaning)
Simple constructor. |
Method Summary |
java.lang.String |
meaning()
Get the content of the param tag. |
static java.lang.String |
returnTag()
Static string representation of the tag. |
java.lang.String |
tag()
String representation of the tag. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ReturnDocTag
public ReturnDocTag(java.lang.String meaning)
- Simple constructor.
- Parameters:
meaning
- the meaning of the returned value- Throws:
java.lang.IllegalArgumentException
- The meaning is a null or an empty string.
meaning
public java.lang.String meaning()
- Get the content of the param tag.
- Returns:
- the meaning.
tag
public java.lang.String tag()
- String representation of the tag.
- Overrides:
tag
in class DocTag
returnTag
public static java.lang.String returnTag()
- Static string representation of the tag.