Class MultilineJavadocTagsCheck

  • All Implemented Interfaces:,

    public final class MultilineJavadocTagsCheck
    Check indents in multi line JavaDoc tags.

    This is how you should format javadoc tags that need a few lines:

      * This is my new method.
      * @param text Some text information, provided to the
      *  method by another class
      * @todo #123 I will implement it later, when more information
      *  come to light and I have documentation supplied by
      *  AAA team in the office accross the street
     public void func() {
         // ...

    Keep in mind that all free-text information should go before javadoc tags, or else it will treated as part of the latest tag and qulice will complain.

    • 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 visitToken​( ast)  
      • Methods inherited from class

        beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, 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

      • MultilineJavadocTagsCheck

        public MultilineJavadocTagsCheck()
    • 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
      • visitToken

        public void visitToken​( ast)
        visitToken in class