Repository navigation
[WIP] Rewrite Javadoc comments to Markdown - #14334
Closed
Strokkur424 wants to merge 2 commits into
Closed
Strokkur424 wants to merge 2 commits into
Strokkur424 wants to merge 2 commits into
Conversation
github-project-automation
Bot
moved this from Awaiting review
to Closed
in Paper PR Queue
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR serves as a reference to what a possible refactor from regular Javadoc comments (
/**) to Markdown-style comments (///) might look like.IntelliJ supports conversion from standard-style Javadoc comments to Markdown flavored ones. All changes in this PR are thus done from the IntelliJ refactor tool. This may obviously result in bugs. And with almost every single API file touched, review of this is hard.
A possible solution to this problem is to compare the old Javadoc JAR contents to the new - they should theoretically match almost 1:1. This ensures no information was lost.
One issue with the current setup is that Checkstyle does not support Markdown-style Javadoc comments. Progress on that can be tracked with the following issue: checkstyle/checkstyle#16100.
This results in the following roadmap/TODO list, before Markdown Javadoc comments can actually be considered for the API module:
The purpose of this PR is to track these steps, while maybe encouraging discussion and opinions by both contributors and maintainers. This should have no effect on consumers of the API or server owners running Paper.