public final class MissingDeprecatedCheck extends Check
This class is used to verify that both the
and the deprecated javadoc tag are present when
either one is present.
Both ways of flagging deprecation serve their own purpose. The
Deprecated annotation is used for
compilers and development tools. The deprecated javadoc tag is
used to document why something is deprecated and what, if any,
In order to properly mark something as deprecated both forms of deprecation should be present.
Package deprecation is a exception to the rule of always using the javadoc tag and annotation to deprecate. Only the package-info.java file can contain a Deprecated annotation and it CANNOT contain a deprecated javadoc tag. This is the case with Sun's javadoc tool released with JDK 1.6.0_11. As a result, this check does not deal with Deprecated packages in any way. No official documentation was found confirming this behavior is correct (of the javadoc tool).
To configure this check do the following:
|Constructor and Description|
|Modifier and Type||Method and Description|
The configurable token set.
Returns the default token a check is interested in.
Called to process a token.
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int getDefaultTokens()
public int getAcceptableTokens()
Copyright © 2001-2012. All Rights Reserved.