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

Support Markdown Documentation Comments (JEP 467, JDK 23) #1193

Open
odenix opened this issue Nov 20, 2024 · 0 comments
Open

Support Markdown Documentation Comments (JEP 467, JDK 23) #1193

odenix opened this issue Nov 20, 2024 · 0 comments

Comments

@odenix
Copy link

odenix commented Nov 20, 2024

Consider the following code:

import java.nio.ByteBuffer;

interface BufferAllocator {
  /// Returns a lease for a [ByteBuffer] with at least the specified [capacity][ByteBuffer#capacity].
  LeasedByteBuffer getByteBuffer(long minCapacity);
}

Formatting the above code causes the following issues:

  1. The doc comment is split into two lines, but the second line starts with // instead of ///.
  2. The import statement is removed, breaking the links.

Disabling Javadoc formatting doesn't prevent either issue.
The only workaround I could find was to disable google-java-format.

Tested with JDK 23 and google-java-format 1.24.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

No branches or pull requests

1 participant