google / google/google-java-format
Don't reformat 'javadoc' comments that appear before package/imports, to avoid mangling license headers
- Dominant language
- Java
- Stars
- 6.2k
- Forks
- 937
- Avg merge
- 6m
- Merged PRs (30d)
- 3
Description
The use case is license headers added by, for instance, maven [license](http://www.mojohaus.org/license-maven-plugin/) [plugins](https://github.com/mycila/license-maven-plugin). These headers are not by default formatted in the way that google-java-format requires, and since neither (for good reasons - neither code styles nor licenses should be changed lightly) are very configurable, conflicts are hard to avoid. (The mycila license plugin allows configuration, and with a bit of effort, you can make it create license headers that don't get reformatted - I haven't succeeded to do that with the Codehaus plugin).
Creating this issue as a different one than #139, which is about javadoc comments.
Contributor guide
Assessment
This issue has not been assessed yet.