Class JavadocTagContinuationIndentationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class JavadocTagContinuationIndentationCheck
    extends AbstractJavadocCheck

    Checks the indentation of the continuation lines in at-clauses.

    Default configuration:

     <module name="JavadocTagContinuationIndentation">
         <property name="offset" value="4"/>
     </module>
     
    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values
      • DEFAULT_INDENTATION

        private static final int DEFAULT_INDENTATION
        Default tag continuation indentation.
        See Also:
        Constant Field Values
      • offset

        private int offset
        How many spaces to use for new indentation level.
    • Constructor Detail

      • JavadocTagContinuationIndentationCheck

        public JavadocTagContinuationIndentationCheck()
    • Method Detail

      • setOffset

        public void setOffset​(int offset)
        Sets custom indentation level.
        Parameters:
        offset - custom value.
      • getAllNewlineNodes

        private static java.util.List<DetailNode> getAllNewlineNodes​(DetailNode descriptionNode)
        Finds and collects all NEWLINE nodes inside DESCRIPTION node.
        Parameters:
        descriptionNode - DESCRIPTION node.
        Returns:
        List with NEWLINE nodes.
      • isInlineDescription

        private static boolean isInlineDescription​(DetailNode description)
        Checks, if description node is a description of in-line tag.
        Parameters:
        description - DESCRIPTION node.
        Returns:
        true, if description node is a description of in-line tag.