Long lines in Markdown style are split in a mix of Markdown Javadoc comment and single line comment.

Open
#2,799 0 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
java
Domain
tooling

Research direction

Start by reproducing the issue with Java 25 and the long Markdown Javadoc comment shown in the report. Trace the formatter entry point that wraps comments; done means wrapped lines retain three slashes and remain part of the Javadoc comment.

Written by the indexing model from the issue text.

Description

If i write a very long Markdown Javadoc comment with Java 25, it splits the line, but the new line only has two slashes rather than three to continue the Javadoc comment.

Example:

/// This is a very long comment that will very likely higher than eighty characters and that should definitely be wrapped at some point.

Applying spotless then results in the following:

/// This is a very long comment that will very likely higher than eighty
// characters and that should definitely be wrapped at some point.

It should result in this (just add a third slash):

/// This is a very long comment that will very likely higher than eighty
/// characters and that should definitely be wrapped at some point.
Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.