Improve javadocs

[marcosnils]

Javadocs are mainly a copy/paste of the redis documentation. We need to change them to represent proper java types and exception handling.

There are also methods which doesn't have any javadoc at all.

[nrktkt]

Just ran into #976 as well and finding the docs lacking.
Whats the status on this issue?

[marcosnils]

@kag0 we're working on some important core features of Jedis at this moment and we're only two active collaborators. Any help would be much appreciated 😄

[HeartSaVioR]

I thought about Javadoc a little.

As Marcos said, we're only two active collaborators.
I'm wondering we could perfectly maintain source codes with javadoc. It was already nearly unmaintained, and I think it can't be changed unless we have many active contributors or collaborators.

Btw, we can move javadoc from implementations to interfaces, and use @inheritdoc tag to reduce amount of duplicated comments.
@marcosnils What do you think?

[marcosnils]

@HeartSaVioR moving Javadocs to interfaces seems the right way to go. I don't have time to do that kind of work at this moment, hopefully some new collaborator would help :)

[HeartSaVioR]

OK. I also think we may just replace the explanations for the command to link to Redis doc, since it is actively maintained with many contributors.

[marcosnils]

If we replace javadocs with redis links then users without internet connection won't be able to see the docs (which is kind of sad). Redis docs are stored in a JSON format in the redis page repo.

Maybe we can annotate the javadocs in some way which allows us to run a simple program which takes the commands description form the redis json doc and replaces it into Jedis. I'm not sure about this exactly but I agree with you that maintaining the documentation is quite messy as we don't have the enough collaborators to do it ATM.

[nrktkt]

javadocs support html in the comments, so you could potentially do something there with the redis docs. Wouldn't fix issues like #976 though.
I wouldn't be opposed to helping to get some native docs in place, I just don't know when I'd have time. At bare minimum it shouldn't be hard to get default javadocs up on gh-pages as a starter.

[marcosnils]

@kag0 👍

[nrktkt]

@marcosnils will you please create a gh-pages branch (off of master) so I can open a PR into it?

[HeartSaVioR]

@kag0 Done.

[github-actions]

This issue is marked stale. It will be closed in 30 days if it is not updated.