Skip to content
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

JavaDoc checks missing customizable JavaDoc tokens #2427

Closed
rnveach opened this issue Oct 23, 2015 · 5 comments
Closed

JavaDoc checks missing customizable JavaDoc tokens #2427

rnveach opened this issue Oct 23, 2015 · 5 comments
Assignees
Milestone

Comments

@rnveach
Copy link
Member

rnveach commented Oct 23, 2015

<property name="target" value="JAVADOC_TAG_THROWS_LITERAL, JAVADOC_TAG_DEPRECATED_LITERAL"/>

CS' documentation makes reference to customizing what JavaDoc tags the checks process.
The issue is the checks actually do not support this feature currently.

When trying the example above, I get the following exception:

CheckstyleException: Property 'target' in module NonEmptyAtclauseDescription does not exist

AbstractJavadocCheck should have the following methods: getJavadocTokens , getRequiredJavadocTokens, getAcceptableJavadocTokens

This Check need to be updated to have properly named option for tokens:

@romani
Copy link
Member

romani commented Oct 23, 2015

@baratali , please take a look, we need your assistance there.

@baratali
Copy link
Contributor

Once this issue is resolved, "Writing Javadoc Checks" wiki-page should be updated with explanations how to use new methods and customize Javadoc Checks: http://checkstyle.sourceforge.net/writingjavadocchecks.html#Customize_token_types_in_Javadoc_Checks

@rnveach
Copy link
Member Author

rnveach commented Oct 23, 2016

@romani
@baratali If it is ok and you have no plans to work on this soon, I could start the process now by adding the methods and adjusting the checks if needed.

@romani
Copy link
Member

romani commented Oct 23, 2016

@rnveach , contributor @baratali does not have any assignments on project. Looks like he does not have time to contribute more.
He did great effort to sum-up all problems at howto page with all issues that that need to be resolved before we could start updating our.
You are welcome to take any issue that is not assigned to fix it.

rnveach added a commit to rnveach/checkstyle that referenced this issue Oct 23, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Oct 25, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Oct 25, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Oct 25, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Oct 31, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Nov 1, 2016
rnveach added a commit to rnveach/checkstyle that referenced this issue Nov 1, 2016
@romani romani added this to the 7.3 milestone Nov 1, 2016
@romani
Copy link
Member

romani commented Nov 1, 2016

fix is merged.

@romani romani closed this as completed Nov 1, 2016
@romani romani reopened this Nov 11, 2016
@romani romani closed this as completed Nov 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants