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 for methods/variables of exported classes #219

Closed
svilenvul opened this issue Nov 24, 2017 · 3 comments
Closed

Javadoc for methods/variables of exported classes #219

svilenvul opened this issue Nov 24, 2017 · 3 comments

Comments

@svilenvul
Copy link
Contributor

Currently we have the JavadocFilterCheck which checks classes for missing javadoc, but we can add further checks for methods and variables.

A good candidate for that may be:
https://github.com/Adobe-Consulting-Services/checkstyle-osgi-checks

This is a series of Checkstyle checks specific to working in an OSGi environment.
ExportedJavadocMethod
Same as JavadocMethod, but allows missing JavaDoc on non-exported classes.
ExportedJavadocType
Same as JavadocType, but allows missing JavaDoc on non-exported classes.
ExportedJavadocVariable
Same as JavadocVariable, but allows missing JavaDoc on non-exported classes.

It is available on mvnrepository as well.

@svilenvul
Copy link
Contributor Author

Actually it is not in MVNrepository :-(, it is in https://repo.adobe.com/nexus/content/repositories/public/.

@svilenvul
Copy link
Contributor Author

This repository is dead, no new commits in the last few years. The version of the Checkstyle API that is being used is outdated.

We should implement the checks by our own.

@VelinYordanov
Copy link
Contributor

I'll start work on that.

VelinYordanov added a commit to MusalaSoft/static-code-analysis that referenced this issue May 3, 2018
Closes openhab#219

Signed-off-by: VelinYordanov <velin.iordanov@gmail.com>
VelinYordanov added a commit to MusalaSoft/static-code-analysis that referenced this issue May 3, 2018
Closes openhab#219

Signed-off-by: VelinYordanov <velin.iordanov@gmail.com>
VelinYordanov added a commit to MusalaSoft/static-code-analysis that referenced this issue Jun 27, 2018
Closes openhab#219

Signed-off-by: VelinYordanov <velin.iordanov@gmail.com>
VelinYordanov added a commit to MusalaSoft/static-code-analysis that referenced this issue Jul 2, 2018
Closes openhab#219

Signed-off-by: VelinYordanov <velin.iordanov@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants