brigadier icon indicating copy to clipboard operation
brigadier copied to clipboard

[Suggestion] Host javadocs online

Open Pante opened this issue 6 years ago • 4 comments

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.

Pante avatar Mar 18 '19 03:03 Pante

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

MiniDigger avatar Mar 18 '19 10:03 MiniDigger

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

Pante avatar Mar 20 '19 15:03 Pante

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...

Andre601 avatar Mar 08 '21 03:03 Andre601

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

SirYwell avatar Mar 09 '21 08:03 SirYwell