|
|||||||||
| Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ] | PREV CLASS NEXT CLASS | ||||||||
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||
com.puppycrawl.tools.checkstyle.checks
Class JavadocTag
java.lang.Objectcom.puppycrawl.tools.checkstyle.checks.JavadocTag
- class JavadocTag
- extends java.lang.Object
Represents a Javadoc tag. Provides methods to query what type of tag it is.
| Field Summary | |
private java.lang.String |
mArg1
an optional first argument. |
private int |
mLineNo
the line number of the tag |
private java.lang.String |
mTag
the tag string |
| Constructor Summary | |
(package private) |
JavadocTag(int aLine,
java.lang.String aTag)
Constructs the object. |
(package private) |
JavadocTag(int aLine,
java.lang.String aTag,
java.lang.String aArg1)
Constructs the object. |
| Method Summary | |
(package private) java.lang.String |
getArg1()
|
(package private) int |
getLineNo()
|
(package private) java.lang.String |
getTag()
|
(package private) boolean |
isAuthorTag()
|
(package private) boolean |
isParamTag()
|
(package private) boolean |
isReturnTag()
|
(package private) boolean |
isSeeOrInheritDocTag()
|
(package private) boolean |
isThrowsTag()
|
java.lang.String |
toString()
Convert this Object to a human-readable String. |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
mLineNo
private final int mLineNo
- the line number of the tag
mTag
private final java.lang.String mTag
- the tag string
mArg1
private final java.lang.String mArg1
- an optional first argument. For example the parameter name.
| Constructor Detail |
JavadocTag
JavadocTag(int aLine,
java.lang.String aTag,
java.lang.String aArg1)
- Constructs the object.
JavadocTag
JavadocTag(int aLine,
java.lang.String aTag)
- Constructs the object.
| Method Detail |
getTag
java.lang.String getTag()
getArg1
java.lang.String getArg1()
getLineNo
int getLineNo()
toString
public java.lang.String toString()
- Description copied from class:
java.lang.Object - Convert this Object to a human-readable String.
There are no limits placed on how long this String
should be or what it should contain. We suggest you
make it as intuitive as possible to be able to place
it into System.out.println() 55
and such.
It is typical, but not required, to ensure that this method never completes abruptly with a java.lang.RuntimeException.
This method will be called when performing string concatenation with this object. If the result is
null, string concatenation will instead use"null".The default implementation returns
getClass().getName() + "@" + Integer.toHexString(hashCode()).
isAuthorTag
boolean isAuthorTag()
isReturnTag
boolean isReturnTag()
isParamTag
boolean isParamTag()
isThrowsTag
boolean isThrowsTag()
isSeeOrInheritDocTag
boolean isSeeOrInheritDocTag()
|
|||||||||
| Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ] | PREV CLASS NEXT CLASS | ||||||||
|
SUMMARY: JAVADOC | SOURCE | DOWNLOAD | NESTED | FIELD | CONSTR | METHOD |
DETAIL: FIELD | CONSTR | METHOD | ||||||||