Resolves #1995, flag to format JavaDoc for Palantir formatter #2009
Conversation
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
blutorange changed the title 
Goooler reviewed Jan 18, 2024
lib/src/main/java/com/diffplug/spotless/java/PalantirJavaFormatStep.java Outdated Show resolved Hide resolved
Co-authored-by: Zongle Wang <wangzongler@gmail.com>
| Shipped in |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 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.
Adds a
formatJavadocflag to the Palantir formatter (Maven + Gradle) to enable Java Doc to be formatted, resolves #1995This requires at least Palantir version 2.36.0, although there seem to be some issues with dependency resolution (see palantir/palantir-java-format#976), which seem to be fixed in Palantir version 2.39.0, so I used that version in the README.
To support older versions, the
builder.formatJavadoc(true)method is called via reflection only if required.After creating the PR, please add a commit that adds a bullet-point under the
[Unreleased]section of CHANGES.md, plugin-gradle/CHANGES.md, and plugin-maven/CHANGES.md which includes: