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

Consider publishing javadocs #3

Open
php-coder opened this issue Oct 3, 2017 · 5 comments
Open

Consider publishing javadocs #3

php-coder opened this issue Oct 3, 2017 · 5 comments

Comments

@php-coder
Copy link

It would be great to have javadocs published somewhere.

@ctapobep
Copy link
Member

ctapobep commented Oct 3, 2017

You mean as a webpage? I don't know how useful it is - you can download sources with Maven/intelliJ and it's going to show you the javadocs right in IDE..

@php-coder
Copy link
Author

php-coder commented Oct 3, 2017

My IDEA is broken and I can't download javadocs :) But, seriously, it could be helpful to users who don't use smart IDEs. Also it can be useful to newcomers to take a quick look on the available methods.

(I'm trying to use this library and I'm missing a good quick start with examples. Shall I create an issue for that or it never be fixed? :) )

@ctapobep
Copy link
Member

ctapobep commented Oct 3, 2017

Oookay.. I didn't know someone was still using javadocs sites :) It'll probably take me some time to get my hands on it though.

@vladimir-bukhtoyarov
Copy link

@ctapobep the published javadocs are very useful in public discussions, when your library became so popular that are discussed outside the github issue tracker.

@php-coder
Copy link
Author

This could be helpful: http://www.javadoc.io/ Also it will be possible to add a badge to readme :)

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

No branches or pull requests

3 participants