#1021: Fix checkstyle warnings by changing the license header template #1027
Conversation
This file contains 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
iluwatar
added
status:under construction
status: under review
and removed
status:under construction
labels
iluwatar
approved these changes
Oct 22, 2019
|
@vanogrid thanks, this is a great step forward in solving that issue! |
|
New problem was detected, see #1037 |
|
Sorry about that, I will have a look asap. |
|
No problem @vanogrid. Thanks for looking into it 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #1021
Google's Checkstyle ruleset doesn't play well with the javadoc license headers, because it demands the first line to have a dot at the end, a
<p>tag at the beginning of a paragraph, etc.I changed the license header style to the
SLASHSTAR_STYLE, provided with the license-maven-plugin (which is also the default one now, but after v3.0 there is no new release yet). Checkstyle didn't like that one either and wanted the package name to be "separated from the previous statement" by a blank line, so I ended up creating a custom license header with this blank line added (license-plugin-header-style.xml). This fixed the issues with the license header. There were minimal changes in the code and now the Checkstyle warnings are less than half (2,8k). The issue is not done yet, but this should be a good start.