Skip to content
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

Resolves #1995, flag to format JavaDoc for Palantir formatter #2009

Merged
merged 2 commits into from
Jan 22, 2024

Conversation

blutorange
Copy link
Contributor

@blutorange blutorange commented Jan 18, 2024

Adds a formatJavadoc flag to the Palantir formatter (Maven + Gradle) to enable Java Doc to be formatted, resolves #1995

This 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:

  • a summary of the change
  • either
    • a link to the issue you are resolving (for small changes)

@blutorange blutorange changed the title Implements #1995, flag to format JavaDoc for Palantir formatter Resolves #1995, flag to format JavaDoc for Palantir formatter Jan 18, 2024
CHANGES.md Outdated Show resolved Hide resolved
plugin-gradle/CHANGES.md Outdated Show resolved Hide resolved
plugin-maven/CHANGES.md Outdated Show resolved Hide resolved
Co-authored-by: Zongle Wang <wangzongler@gmail.com>
@Goooler Goooler requested a review from nedtwigg January 18, 2024 13:08
@nedtwigg nedtwigg merged commit 13d9627 into diffplug:main Jan 22, 2024
13 checks passed
@nedtwigg
Copy link
Member

Shipped in plugin-gradle 6.25.0 and plugin-maven 2.43.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Option to enable JavaDoc formatting for Palantir code formatter
4 participants