Paper
Paper copied to clipboard
PaperMC
Add Brigadier Javadocs
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
Maybe an alternative would be hosting brigadier compiled with sources and javadocs on paper's official repo. Brigadier is MIT so the license permits redistributing brigadier
Issue is that brigadier doesn’t have Java docs, there is a pr to change that, but, nothing has been said from mojang regarding this
On Sun, 5 Jan 2025 at 15:08, masmc05 @.***> wrote:
Maybe an alternative would be hosting brigadier compiled with sources and javadocs on paper's official repo. Brigadier is MIT so the license permits redistributing brigadier
— Reply to this email directly, view it on GitHub https://github.com/PaperMC/Paper/issues/11915#issuecomment-2571657063, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJMAZAIYUL6NJV63HZFRHT2JFDE7AVCNFSM6AAAAABUUFX5MCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZRGY2TOMBWGM . You are receiving this because you are subscribed to this thread.Message ID: @.***>
Indeed. That's why my suggestion would be to write some ourselves. I can understand this being a lot of time spend for minimal gains though
I did bring merging and pushing that pr ourselves internally a short while back I think, so we’d have JDs for that; it is a pain that there is currently stuff which people can’t see and miss out on due to this
On Sun, 5 Jan 2025 at 15:32, Strokkur24 @.***> wrote:
Indeed. That's why my suggestion would be to write some ourselves. I can understand this being a lot of time spend for minimal gains though
— Reply to this email directly, view it on GitHub https://github.com/PaperMC/Paper/issues/11915#issuecomment-2571664246, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAJMAZF3BCFT6YN64N5W4A32JFGBVAVCNFSM6AAAAABUUFX5MCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZRGY3DIMRUGY . You are receiving this because you commented.Message ID: @.***>
Have there been any more internal discussions regarding this? It seems to be more and more important with the waves of people who have been switching to Brigadier lately