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

DesignForExtension: consider overridable methods and javadoc #3102

Closed
romani opened this Issue Apr 15, 2016 · 1 comment

Comments

Projects
None yet
2 participants
@romani
Member

romani commented Apr 15, 2016

http://checkstyle.sourceforge.net/config_design.html#DesignForExtension

documentation now describe all rationale of this Check. But Rationale doe snot match with logic of this Check.
Missed points:

  • validation for overridable methods usage in class (we already have similar functionality at OverridableMethodInConstructorCheck )
  • validation of javadoc where user need to put explanation of how to override it correctly. Please pay attention to ...The description begins with the phrase “This implementation.” - need to be investigated.

so this two point need to be done.
We need to activate this Check over our code , at least some part of it, to show users how it could be used (with reasonable level of suppression).

We also need to extend documentation to mention that there is a limitation:

We can not validate overridable methods of parent class that are used in tested class. All of them will be skipped

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 10, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 10, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 13, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 13, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 13, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Aug 13, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 8, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 11, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Sep 12, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 6, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 6, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 19, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 19, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 19, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 19, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 20, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 20, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 20, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 22, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 22, 2016

MEZk added a commit to MEZk/checkstyle that referenced this issue Oct 22, 2016

romani added a commit that referenced this issue Oct 22, 2016

@romani romani added this to the 7.2 milestone Oct 22, 2016

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Oct 22, 2016

Member

fix is merged.

Member

romani commented Oct 22, 2016

fix is merged.

@romani romani closed this Oct 22, 2016

agcuda added a commit to agcuda/checkstyle that referenced this issue Oct 30, 2016

agcuda added a commit to agcuda/checkstyle that referenced this issue Oct 30, 2016

agcuda added a commit to agcuda/checkstyle that referenced this issue Oct 30, 2016

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