feat: Add a only javadoc application mode to the parchment plugin #57
Conversation
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
1 participant
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 pull request adds a new CLI option,
--only-parchment-javadoc, which when set, overrides the--[no-]-parchment-javadocsetting and skips the parameter renaming step while recording replacements for@paramnames in the javadocs, based on the source and finally applying the JDs to the source. The replacement step is there for correct@paramnames.It is useful for projects that use their own tooling for param names but still want to benefit from the javadocs specified in Parchment, which this feature allows them to do. 🎉
The idea behind this was brought up in discord some time ago in the #tooling-dev channel