Skip to content

feat(paper): document how to download Javadocs in the IDE - #817

Open
spa77k wants to merge 1 commit into
PaperMC:mainfrom
spa77k:docs/manual-javadoc
Open

spa77k wants to merge 1 commit into
PaperMC:mainfrom
spa77k:docs/manual-javadoc

Conversation

@spa77k

@spa77k spa77k commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Closes #341.

Adds a "Downloading Javadocs" section to the project setup page, after the dependency tabs:

  • Gradle: apply the idea plugin and set isDownloadJavadoc = true, so IntelliJ downloads the Javadocs on every project sync (the option defaults to false).
  • Maven: download them from the Maven tool window or enable Documentation under Automatically download in the Importing settings. Outside an IDE, mvn dependency:resolve -Dclassifier=javadoc puts the Javadoc JARs in the local repository.
  • A link to the online Javadocs at jd.papermc.io.

The steps follow the IntelliJ IDEA Javadocs page and the Gradle IdeaModule DSL reference.

Verification:

  • Confirmed that the PaperMC repository serves -javadoc and -sources JARs for paper-api.
  • Ran mvn dependency:resolve -Dclassifier=javadoc against a paper-api dependency and checked that the Javadoc JAR was downloaded.
  • pnpm build and prettier --check on the changed file passed.

@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview f699231

This branch was successfully deployed

1 active deployment
Preview — f6992311 Deployed Oct 21, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document how to manually download javadoc

2 participants