Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Suggestion] Host javadocs online #53

Open
Pante opened this issue Mar 18, 2019 · 4 comments · May be fixed by #71
Open

[Suggestion] Host javadocs online #53

Pante opened this issue Mar 18, 2019 · 4 comments · May be fixed by #71

Comments

@Pante
Copy link

Pante commented Mar 18, 2019

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 Pante changed the title [Enchantment] Host javadocs online [Suggestion] Host javadocs online Mar 18, 2019
@MiniDigger
Copy link

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

@Pante
Copy link
Author

Pante commented Mar 20, 2019

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

@Andre601
Copy link

Andre601 commented Mar 8, 2021

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
Copy link

SirYwell commented Mar 9, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants