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

Already on GitHub? Sign in to your account

Improve JavadocMethod Check #70

Open
romani opened this Issue Nov 3, 2012 · 7 comments

Comments

Projects
None yet
7 participants
Owner

romani commented Nov 3, 2012

Improve JavadocMethod check to cover only abstract methods, or only inheritable methods, or only final methods etc.

http://sourceforge.net/tracker/index.php?func=detail&aid=2959656&group_id=29721&atid=397081

Additional request is to - Force users to write java doc for Interfaces/Abstract classes only.
http://sourceforge.net/tracker/?func=detail&aid=2959656&group_id=29721&atid=397081
http://stackoverflow.com/questions/13271326/checkstyle-check-only-method-in-interface

@ghost ghost assigned Andrey91 Feb 7, 2013

@ghost ghost assigned Sawyer91 Apr 30, 2013

@daniilyar daniilyar added easy and removed enhancement labels Aug 15, 2014

Contributor

alex-zuy commented Sep 4, 2014

Why shoud we force writting JavaDoc for final methods ?

Contributor

alex-zuy commented Sep 4, 2014

Shoud we always skip anonymous classes along with private inner classes ?

Owner

romani commented Sep 6, 2014

@daniilyar , please put answers as we discussed.

Contributor

alex-zuy commented Sep 10, 2014

new check options to implement:
check public methods(defaults to true)
check private methods(defaults to false)
check protected methods(defaults to false)
check final methods(defaults to false)
check inherited methods(defaults to false)

Always skip:
private inner classes
anonymous classes

Please review.

About Interfaces/Abstract classes: what if abstract class or interface is keept in separate file? CheckStyle cannot handle this case as far as I know.

Owner

daniilyar commented Sep 10, 2014

@pirat9600q, This check is waiting for moving to new JavaDoc comments processing algorithm.. so, it seems like it is better to postpone any changes on it for now. Lets discuss

Sebl29 commented May 12, 2015

Hi,
I need to assure that every interface method is documented. Any news on that issue or the "new JavaDoc comments processing algorithm"?

Owner

romani commented May 13, 2015

"new JavaDoc comments processing algorithm"

It is implemented, examples:
https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java#L75
https://github.com/checkstyle/checkstyle/blob/master/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/AtclauseOrderCheck.java

but it is not yet used widely, as we have to much bugs in existing Checks, so we postponed refactoring of existing Checks. But you can help us, to make it available earlier.

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