diff --git a/src/xdocs/writingjavadocchecks.xml.vm b/src/xdocs/writingjavadocchecks.xml.vm index d6cf8e5ee..54a6d983d 100644 --- a/src/xdocs/writingjavadocchecks.xml.vm +++ b/src/xdocs/writingjavadocchecks.xml.vm @@ -496,12 +496,18 @@ java -cp checkstyle-${projectVersion}-all.jar com.puppycrawl.tools.checkstyle.gu
+

+ Java checks controlled by method setTokens(), getDefaultTokens(), getAccessibleTokens(), getRequiredTokens(). + JavaDoc checks use the same model plus extra 4 methods for Javadoc tokens. + As Java AST and Javadoc AST are not binded. + It is highly recommended for Javadoc checks do not use customization of java tokens and expect to be executed only on javadoc tokens. +

There are four methods in AbstractJavadocCheck class to control the processed JavadocTokenTypes - one setter - setTokens(), which is used to define a custom set (which is different + setJavadocTokens(), which is used to define a custom set (which is different from the default one) of the processed JavadocTokenTypes via config file and three getters, which have to be overridden: @@ -515,19 +521,26 @@ java -cp checkstyle-${projectVersion}-all.jar com.puppycrawl.tools.checkstyle.gu