Skip to content

feat: Add a only javadoc application mode to the parchment plugin - #57

Closed
Toffikk wants to merge 2 commits into
neoforged:mainfrom
Toffikk:parchment_only_javadoc_mode
Closed

Toffikk wants to merge 2 commits into
neoforged:mainfrom
Toffikk:parchment_only_javadoc_mode

Conversation

@Toffikk

@Toffikk Toffikk commented Oct 7, 2025

Copy link
Copy Markdown

This pull request adds a new CLI option, --only-parchment-javadoc, which when set, overrides the --[no-]-parchment-javadoc setting and skips the parameter renaming step while recording replacements for @param names in the javadocs, based on the source and finally applying the JDs to the source. The replacement step is there for correct @param names.
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

@neoforged-pr-publishing

Copy link
Copy Markdown
  • Publish PR to GitHub Packages

@neoforged-automation

Copy link
Copy Markdown
Contributor

@Toffikk, this pull request has conflicts, please resolve them for this PR to move forward.

@neoforged-automation neoforged-automation Bot added the needs rebase This Pull Request needs to be rebased before being merged label Dec 20, 2025
@shartte

shartte commented Dec 20, 2025

Copy link
Copy Markdown
Contributor

Implemented in #60, since we need this for unobf Minecraft

@shartte shartte closed this Dec 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs rebase This Pull Request needs to be rebased before being merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants