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

Any documentation at all? #220

Open
2 tasks
petercwallis opened this issue Apr 30, 2021 · 2 comments
Open
2 tasks

Any documentation at all? #220

petercwallis opened this issue Apr 30, 2021 · 2 comments

Comments

@petercwallis
Copy link

Info

This is:

  • [X ] bug report
  • feature request
  • other

Installing and using the plugin is easy, but modifying it, or creating another plugin that uses it is impossible as it is just not documented. I tried running javadoc over the source so I could at least get a set of public methods, but no, it's maven only by the looks of things. Could we have the documentation generated and put here somewhere please. This is not a feature request - it is a bug report. Perhaps with documentation others would then fix some of the other issues.

@PetteriM1
Copy link
Member

PetteriM1 commented Apr 30, 2021

You can still check how stuff work from the code. Also javadoc with mvn javadoc:javadoc should work just fine or at least that's how I generated http:https://suomicraftpe.ddns.net/javadocs/mobplugin-nukkitx/

Pull requests that adds more documentation to the code are welcome.

@petercwallis
Copy link
Author

petercwallis commented May 1, 2021 via email

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

No branches or pull requests

2 participants