Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocTagContinuationIndentationCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class JavadocTagContinuationIndentationCheck
extends AbstractJavadocCheck

    Checks the indentation of the continuation lines in block tags. That is whether the continued description of at clauses should be indented or not. If the text is not properly indented it throws a violation. A continuation line is when the description starts/spans past the line with the tag. Default indentation required is at least 4, but this can be changed with the help of properties below.

    • Property offset - Specify how many spaces to use for new indentation level. Type is int. Default value is 4.
    • Property violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type is boolean. Default value is false.

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • javadoc.missed.html.close
    • javadoc.parse.rule.error
    • javadoc.unclosedHtml
    • javadoc.wrong.singleton.html.tag
    • tag.continuation.indent
    Since:
    6.0

    • 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

      • offset

        private int offset
        Specify how many spaces to use for new indentation level.

    • Method Detail

      • setOffset

        public void setOffset​(int offset)
        Setter to specify how many spaces to use for new indentation level.
        Parameters:
        offset - custom value.
        Since:
        6.0

      • isViolation

        private boolean isViolation​(DetailNode textNode)
        Checks if a text node meets the criteria for a violation. If the text is shorter than offset characters, then a violation is detected if the text is not blank or the next node is not a newline. If the text is longer than offset characters, then a violation is detected if any of the first offset characters are not blank.
        Parameters:
        textNode - the node to check.
        Returns:
        true if the node has a violation.

      • 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.