com.qulice.checkstyle

Class JavadocTagsCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.qulice.checkstyle.JavadocTagsCheck

All Implemented Interfaces:

Configurable, Contextualizable

public final class JavadocTagsCheck
extends Check

Check if the class/interface javadoc contains properly formatted author and version tags.

Correct format is the following (of a class javadoc):

 /**
  * This is my new class.
  *
  * @author John Doe (john@example.com)
  * @version $Id$
  */
 public final class Foo {
     // ...
 

"$Id$" will be replaced by a full text automatically by Subversion as explained in their documentation (see link below).

Since:

0.3

Version:

$Id$

Author:

Krzysztof Krason (Krzysztof.Krason@gmail.com), Yegor Bugayenko (yegor@tpc2.com)

See Also:

Keywords substitution in Subversion

Suppressed Checkstyle violations:

LineLength (1 line)

Constructor Summary

Constructors

Constructor and Description
JavadocTagsCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens()
void	init()
void	visitToken(DetailAST ast)

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

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

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavadocTagsCheck

public JavadocTagsCheck()

Method Detail

init

public void init()

Overrides:

init in class Check

getDefaultTokens

public int[] getDefaultTokens()

Specified by:

getDefaultTokens in class Check

visitToken

public void visitToken(DetailAST ast)

Overrides:

visitToken in class Check