Add Brigadier Javadocs
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 12.7k
- Forks
- 3.5k
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 11
Description
Is your feature request related to a problem?
Currently, there is no official online hosted Brigadier Javadocs, meaning you cannot look up the Brigadier jd online.
You also do not have any Javadocs in your IDE with Paper-API, even though Brigadier is exposed and Paper-API Javadocs are downloaded.
Describe the solution you'd like.
I would love to have the Brigadier Javadocs included in Paper-API in order to have an easier time reading up on what the individual classes actually do.
Describe alternatives you've considered.
The "best" way to read Brigadier Javadocs currently seems to be the Javadocs of CommandAPI: https://commandapi.jorel.dev/javadocs/html/annotated.html.
To have something similar in Paper would be great.
Other
It seems that Brigadier themselves do not actually define any Javadocs, meaning one would have to map Javadocs to the classes themselves, or we could copy them from CommandAPI
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by inspecting how Paper-API publishes and exposes its existing Javadocs, then compare the Brigadier classes with the CommandAPI Javadocs linked in the issue; the work is done when Brigadier documentation is available both online and through Paper-API's IDE documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100