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

Class JavadocMethodCheck

    • Field Detail

      • MSG_CLASS_INFO

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

      • MSG_UNUSED_TAG_GENERAL

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

      • MSG_INVALID_INHERIT_DOC

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

      • MSG_UNUSED_TAG

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

      • MSG_EXPECTED_TAG

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

      • MSG_RETURN_EXPECTED

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

      • MSG_DUPLICATE_TAG

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

    • Constructor Detail

      • JavadocMethodCheck

        public JavadocMethodCheck()

    • Method Detail

      • setValidateThrows

        public void setValidateThrows​(boolean value)
        Allow validating throws tag.
        Parameters:
        value - user's value.

      • setAllowedAnnotations

        public void setAllowedAnnotations​(java.lang.String... userAnnotations)
        Sets list of annotations.
        Parameters:
        userAnnotations - user's value.

      • setScope

        public void setScope​(Scope scope)
        Set the scope.
        Parameters:
        scope - a scope.

      • setExcludeScope

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

      • setAllowUndeclaredRTE

        public void setAllowUndeclaredRTE​(boolean flag)
        Controls whether to allow documented exceptions that are not declared if they are a subclass of java.lang.RuntimeException.
        Parameters:
        flag - a Boolean value

      • setAllowThrowsTagsForSubclasses

        public void setAllowThrowsTagsForSubclasses​(boolean flag)
        Controls whether to allow documented exception that are subclass of one of declared exceptions.
        Parameters:
        flag - a Boolean value

      • setAllowMissingParamTags

        public void setAllowMissingParamTags​(boolean flag)
        Controls whether to allow a method which has parameters to omit matching param tags in the javadoc. Defaults to false.
        Parameters:
        flag - a Boolean value

      • setAllowMissingThrowsTags

        public void setAllowMissingThrowsTags​(boolean flag)
        Controls whether to allow a method which declares that it throws exceptions to omit matching throws tags in the javadoc. Defaults to false.
        Parameters:
        flag - a Boolean value

      • setAllowMissingReturnTag

        public void setAllowMissingReturnTag​(boolean flag)
        Controls whether to allow a method which returns non-void type to omit the return tag in the javadoc. Defaults to false.
        Parameters:
        flag - a Boolean value

      • setLogLoadErrors

        @Deprecated
public final void setLogLoadErrors​(boolean logLoadErrors)
        Deprecated.
        No substitute.
        Controls whether to log class loading errors to the checkstyle report instead of throwing a RTE.
        Parameters:
        logLoadErrors - true if errors should be logged

      • setSuppressLoadErrors

        @Deprecated
public final void setSuppressLoadErrors​(boolean suppressLoadErrors)
        Deprecated.
        No substitute.
        Controls whether to show class loading errors in the checkstyle report.
        Parameters:
        suppressLoadErrors - true if errors shouldn't be shown

      • getRequiredTokens

        public final 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

      • 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

      • beginTree

        public void beginTree​(DetailAST rootAST)
        Description copied from class: AbstractCheck
        Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
        Overrides:
        beginTree in class AbstractCheck
        Parameters:
        rootAST - the root of the tree

      • leaveToken

        public final void leaveToken​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called after all the child nodes have been process.
        Overrides:
        leaveToken in class AbstractCheck
        Parameters:
        ast - the token leaving