New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update documentation about getAcceptableTokens for javadoc Checks #3672

Closed
romani opened this Issue Dec 21, 2016 · 0 comments

Comments

Projects
None yet
1 participant
@romani
Member

romani commented Dec 21, 2016

Update
http://checkstyle.sourceforge.net/writingjavadocchecks.html

to explain that javadoc tokens can be customize listening behavior of java tree, but it is not conveniet and recommended way.

AbstractJavadocCheck define only default javadoc Checks is TokenTypes.BLOCK_COMMENT_BEGIN only
All checks should run on all comments withtout consideration to what java token it is belong to.

each check need to be filtering himself.
Example: https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java#L106
http://checkstyle.sourceforge.net/config_javadoc.html#AtclauseOrder

romani added a commit that referenced this issue Dec 29, 2016

@romani romani added this to the 7.4 milestone Dec 29, 2016

@romani romani closed this Dec 29, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment