Class JavadocTagsCheck

  • All Implemented Interfaces:,

    public final class JavadocTagsCheck
    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 (
      * @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).

    See Also:
    Keywords substitution in Subversion
    • Nested Class Summary

      • Nested classes/interfaces inherited from class
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int[] getAcceptableTokens()  
      int[] getDefaultTokens()  
      int[] getRequiredTokens()  
      void init()  
      void visitToken​( ast)  
      • Methods inherited from class

        beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
      • Methods inherited from class

        finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
      • Methods inherited from class

        configure, contextualize, getConfiguration, setupChild
    • Constructor Detail

      • JavadocTagsCheck

        public JavadocTagsCheck()
    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        Specified by:
        getDefaultTokens in class
      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Specified by:
        getAcceptableTokens in class
      • getRequiredTokens

        public int[] getRequiredTokens()
        Specified by:
        getRequiredTokens in class
      • init

        public void init()
        init in class
      • visitToken

        public void visitToken​( ast)
        visitToken in class