Add checkstyle rule to forbid empty javadoc comments#20881
Merged
tlrx merged 2 commits intoelastic:masterfrom Nov 21, 2016
Merged
Add checkstyle rule to forbid empty javadoc comments#20881tlrx merged 2 commits intoelastic:masterfrom
tlrx merged 2 commits intoelastic:masterfrom
Conversation
tlrx
commented
Oct 12, 2016
Member
Author
There was a problem hiding this comment.
This slow down the build a bit but not that much on my boxes.
Member
Author
That's another option too, but it checks the summary/first sentence of a Javadoc comment and fails on comments like: or because it does not have a summary line. We have few comments (~20) like this but I suppose I can find a summary for each of those. Analysis time was really similar on my laptop. |
Member
|
I think we probably do want to fix those javadocs but if the speed difference isn't killer then it isn't a high priority. |
Contributor
|
YES PLEASE! |
Member
Author
|
I'm in favor of getting this in in the current state. #20909 would allow us to use all the Javadocs modules from Checkstyle but I didn't manage to get them work correctly for now. |
1ea752c to
f3b1e7d
Compare
This commit adds a RegexpMultiline check to checkstyle that yells when an empty Javadoc comment is found in Java files. Related elastic#20871
f3b1e7d to
5ce150f
Compare
jasontedor
added a commit
to jasontedor/elasticsearch
that referenced
this pull request
Nov 22, 2016
* master: (42 commits) Add support for merging custom meta data in tribe node (elastic#21552) [DOCS] Show EC2's auto attribute (elastic#21474) Add information about the removal of store throttling to the migration guide. Add a recommendation against large documents to the docs. (elastic#21652) Add indices options tests to search api REST tests (elastic#21701) Fixing indentation in geospatial querying example. (elastic#21682) Fix typo in filters aggregation docs (elastic#21690) Add BWC layer for Exceptions (elastic#21694) Add checkstyle rule to forbid empty javadoc comments (elastic#20881) Docs: Added offline install link for discovery-file plugin remove pointless catch exception in TransportSearchAction (elastic#21689) Rename ClusterState#lookupPrototypeSafe to `lookupPrototype` and remove previous "unsafe" unused variant (elastic#21686) Use a buffer to do character to byte conversion in StreamOutput#writeString (elastic#21680) Fix integer overflows when dealing with templates. (elastic#21628) Fix highlighting on a stored keyword field (elastic#21645) Set execute permissions for native plugin programs (elastic#21657) adjust visibility of DiscoveryNodes.Delta constructor Remove unused DiscoveryNodes.Delta constructor Remove unused DiscoveryNode#removeDeadMembers public method Remove minNodeVersion and corresponding public `getSmallestVersion` getter method from DiscoveryNodes ...
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As suggested by @nik9000 in #20871 (comment), this PR adds a checkstyle check to ensure that Java files do not contain any empty Javadoc comment.
This also fix few remaining empty comments.