Skip to content

Allow passing the formatJavadoc flag to Google Java Formatter #614

Description

@coyotesqrl

Back in November, the Google Java Formatter was updated to support turning off formatting of javadocs. This is particularly useful functionality with newer javadoc trends as well as older codebases that include heterogenous license headers.

Here is the PR that added the functionality: google/google-java-format#418

Activity

  1. nedtwigg commented on Jun 18, 2020

    @nedtwigg
    Member

    Happy to take a PR for this (useful guide pr: #193).

    If you'd like to gradually unify the license headers, without ever having a history-clobbering "format-the-world" moment, maybe try ratchetFrom 'origin/main'.

  2. fcurts commented on Jul 17, 2021

    @fcurts

    Is there a workaround/hack for this? We can't adopt the Google formatter without this, as it unnecessarily changes the Javadoc in our entire codebase.

  3. nedtwigg commented on Jul 17, 2021

    @nedtwigg
    Member

    The PR referenced above (#193) is a very similar situation. To my knowledge, no workaround besides a PR.

  4. fcurts commented on Jul 20, 2021

    @fcurts

    Is it possible to support a generic way to pass options so that users aren't blocked every time a new option is added?

  5. nedtwigg commented on Jul 20, 2021

    @nedtwigg
    Member

    Maybe! PR's welcome :)

  6. Goooler commented on Sep 28, 2023

    @Goooler
    Member

    Closed by #1793.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions