ConForM.CoopnTools.CoKer.DocComment
Class ParamDocTag
java.lang.Object
|
+--ConForM.CoopnTools.CoKer.DocComment.DocTag
|
+--ConForM.CoopnTools.CoKer.DocComment.ParamDocTag
- public class ParamDocTag
- extends DocTag
Documentation Parameter Tag. Stores a parameter. Can only appear in
commenst of CoopnSyntacticParamSymbol (once), and in comments of
CoopnSyntacticRelationnalSymbol and CoopnSyntacticFunctionnalSymbol
(one time per parameter, if it appears).
Constructor Summary |
ParamDocTag(java.lang.String meaning)
Simple constructor. |
Method Summary |
java.lang.String |
meaning()
Get the content of the param tag. |
static java.lang.String |
paramTag()
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 |
ParamDocTag
public ParamDocTag(java.lang.String meaning)
- Simple constructor.
- Parameters:
meaning
- the meaning of the parameter- 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
paramTag
public static java.lang.String paramTag()
- Static string representation of the tag.