Class JavadocStyleCheck

    • Field Detail

      • MSG_JAVADOC_MISSING

        public static final java.lang.String MSG_JAVADOC_MISSING
        Message property key for the Unclosed HTML message.
        See Also:
        Constant Field Values
      • MSG_EMPTY

        public static final java.lang.String MSG_EMPTY
        Message property key for the Unclosed HTML message.
        See Also:
        Constant Field Values
      • MSG_NO_PERIOD

        public static final java.lang.String MSG_NO_PERIOD
        Message property key for the Unclosed HTML message.
        See Also:
        Constant Field Values
      • MSG_INCOMPLETE_TAG

        public static final java.lang.String MSG_INCOMPLETE_TAG
        Message property key for the Unclosed HTML message.
        See Also:
        Constant Field Values
      • MSG_UNCLOSED_HTML

        public static final java.lang.String MSG_UNCLOSED_HTML
        Message property key for the Unclosed HTML message.
        See Also:
        Constant Field Values
      • MSG_EXTRA_HTML

        public static final java.lang.String MSG_EXTRA_HTML
        Message property key for the Extra HTML message.
        See Also:
        Constant Field Values
    • Constructor Detail

      • JavadocStyleCheck

        public JavadocStyleCheck()
    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        Description copied from class: AbstractCheck
        Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
        Specified by:
        getDefaultTokens in class AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes
      • getAcceptableTokens

        public int[] getAcceptableTokens()
        Description copied from class: AbstractCheck
        The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
        Specified by:
        getAcceptableTokens in class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes
      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes
      • setScope

        public void setScope​(Scope scope)
        Sets the scope to check.
        Parameters:
        scope - a scope.
      • setExcludeScope

        public void setExcludeScope​(Scope excludeScope)
        Set the excludeScope.
        Parameters:
        excludeScope - a scope.
      • setEndOfSentenceFormat

        public void setEndOfSentenceFormat​(java.util.regex.Pattern pattern)
        Set the format for matching the end of a sentence.
        Parameters:
        pattern - a pattern.
      • setCheckFirstSentence

        public void setCheckFirstSentence​(boolean flag)
        Sets the flag that determines if the first sentence is checked for proper end of sentence punctuation.
        Parameters:
        flag - true if the first sentence is to be checked
      • setCheckHtml

        public void setCheckHtml​(boolean flag)
        Sets the flag that determines if HTML checking is to be performed.
        Parameters:
        flag - true if HTML checking is to be performed.
      • setCheckEmptyJavadoc

        public void setCheckEmptyJavadoc​(boolean flag)
        Sets the flag that determines if empty Javadoc checking should be done.
        Parameters:
        flag - true if empty Javadoc checking should be done.