search

Mojang / brigadier

Brigadier is a command parser & dispatcher, designed and developed for Minecraft: Java Edition.
MIT License
3.41k stars 393 forks source link

[Suggestion] Host javadocs online #53

Open Pante opened 5 years ago

Pante commented 5 years ago

I believe it would be beneficial to host the javadocs online as it is far more convenient to browse through that rather than the source code. Furthermore, it allows the javadocs of dependent projects to link back to the javadocs for brigadier.

MiniDigger commented 5 years ago

the easiest way would be to host them on the gh-pages branch I guess

Pante commented 5 years ago

I decided to host a copy of the javadocs here in the interim until an official copy of the javadocs has been uploaded.

Andre601 commented 3 years ago

When this would become a thing, should IMO the different ArgumentTypes receive some comments to explain them a bit more, like certain limitations (i.e. that you can't just define the max values for int, long, double, etc, but have to set their respective MIN_VALUE instead) and special behaviours like that StringArgumentType.greedyString() will essentially make this argument be the very last one due to the nature of it accepting any amount of Strings.

The ArgumentType class itself doesn't have any comments either which is sad, as I can imagine people wanting to use it to implement their own types and having no info on how to achieve this...

SirYwell commented 3 years ago

There is #47 to expand the docs but who knows if it will ever be merged.