com.puppycrawl.tools.checkstyle.checks.javadoc

Class WriteTagCheck

Implemented Interfaces:
Configurable, Contextualizable

public class WriteTagCheck
extends Check

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>
 
Version:
1.0
Author:
Daniel Grenner

Method Summary

int[]
getAcceptableTokens()
int[]
getDefaultTokens()
protected void
logTag(int aLine, String aTag, String aTagValue)
Log a message.
void
setTag(String aTag)
Sets the tag to check.
void
setTagFormat(String aFormat)
Set the tag format.
void
setTagSeverity(String aSeverity)
Sets the tag severity level.
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Method Details

getAcceptableTokens

public int[] getAcceptableTokens()
Overrides:
getAcceptableTokens in interface Check

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

logTag

protected final void logTag(int aLine,
                            String aTag,
                            String aTagValue)
Log a message.
Parameters:
aLine - the line number where the error was found
aTag - the javdoc tag to be logged
aTagValue - the contents of the tag

setTag

public void setTag(String aTag)
            throws ConversionException
Sets the tag to check.
Parameters:
aTag - tag to check

setTagFormat

public void setTagFormat(String aFormat)
            throws ConversionException
Set the tag format.
Parameters:
aFormat - a String value

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.
Parameters:
aSeverity - The new severity level

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check