com.puppycrawl.tools.checkstyle.checks.javadoc
Class WriteTagCheck
- Configurable, Contextualizable
public class WriteTagCheck
Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets
that sort the report by author name.
To define the format for a tag, set property tagFormat to a
regular expression.
This check uses two different severity levels. The normal one is used for
reporting when the tag is missing. The additional one (tagSeverity) is used
for the level of reporting when the tag exists. The default value for
tagSeverity is info.
An example of how to configure the check for printing author name is:
<module name="WriteTag">
<property name="tag" value="@author"/>
<property name="tagFormat" value="\S"/>
</module>
An example of how to configure the check to print warnings if an
"@incomplete" tag is found, and not print anything if it is not found:
<module name="WriteTag">
<property name="tag" value="@incomplete"/>
<property name="tagFormat" value="\S"/>
<property name="severity" value="ignore"/>
<property name="tagSeverity" value="warning"/>
</module>
beginTree , destroy , finishTree , getAcceptableTokens , getClassLoader , getDefaultTokens , getFileContents , getLines , getRequiredTokens , getTabWidth , getTokenNames , init , leaveToken , log , log , setClassLoader , setFileContents , setMessages , setTabWidth , setTokens , visitToken |
getId , getMessageBundle , getSeverity , getSeverityLevel , log , log , log , log , log , log , log , log , log , log , log , setId , setSeverity |
logTag
protected final void logTag(int aLine,
String aTag,
String aTagValue)
Log a message.
aLine
- the line number where the error was foundaTag
- the javdoc tag to be loggedaTagValue
- the contents of the tag
setTag
public void setTag(String aTag)
throws ConversionException
Sets the tag to check.
setTagFormat
public void setTagFormat(String aFormat)
throws ConversionException
Set the tag format.
setTagSeverity
public final void setTagSeverity(String aSeverity)
Sets the tag severity level. The string should be one of the names
defined in the SeverityLevel
class.
aSeverity
- The new severity level