SpongePowered / SpongeAPI

A Minecraft plugin API
http://www.spongepowered.org/
MIT License
1.14k stars 342 forks source link

docs: add missing p tags and rework existing tag for consistency #2449

Closed ImMorpheus closed 1 year ago

ImMorpheus commented 1 year ago

add implNote when the comment is an implementation detail remove ignored newlines


Opening a PR to gather more feedback on this before pushing more changes.

We're currently using a mix of

* foo
*
* <p>bar

and

* foo
* <p>
* bar

This is confusing and already created some issues (missing paragraphs). Since empty lines are ignored by the javadoc, this PR is using 2) consistently.