Relax SingleLineJavadoc to avoid fighting the formatter

[iamdanfox]

Before this PR

palantir-java-format reflows javadoc comments to fit on one line if possible, e.g.:

/**
  * @param url lorem ipsum
  */	
public foo(String url) {

p-j-f reformatted:

/** @param url lorem ipsum */	
public foo(String url) {

Which resulted in checkstyle failing:

Single-line Javadoc comment should be multi-line.
ERROR: Single-line Javadoc comment should be multi-line.
Category: com.puppycrawl.tools.checkstyle.checks.javadoc.SingleLineJavadocCheck

After this PR

==COMMIT_MSG==
Checkstyle no longer complains about single-line javadoc produced by palantir-java-format.
==COMMIT_MSG==

It still works fine in IntelliJ:

Possible downsides?

• maybe there was some important reason for avoiding single-line javadoc that I don't know about?

[changelog-app]

Generate changelog in changelog/@unreleased

Type

• Feature
• Improvement
• Fix
• Break
• Deprecation
• Manual task
• Migration

Description

Checkstyle no longer complains about single-line javadoc produced by palantir-java-format.

Check the box to generate changelog(s)

• Generate changelog entry

[dansanduleac]

👍