search

Tencent / TubeMQ

TubeMQ has been donated to the Apache Software Foundation and renamed to InLong, please visit the new Apache repository: https://github.com/apache/incubator-inlong
https://inlong.apache.org/
2.02k stars 391 forks source link

Add Javadocs #17

Closed kennethvt437 closed 5 years ago

kennethvt437 commented 5 years ago

Adding javadocs to these interface methods would help clarify what they are supposed to do

tisonkun commented 5 years ago

Hi @kennethvt437. Thanks for your contribution!

I think it also makes sense we introduce a checkstyle rules to enforce every interface methods have a proper javadoc. But back to this pull request I don't think it provides extra benefit we just place a dummy document. In fact, it is even worse, since it possibly passes checker that enforces a javadoc but the document is dummy and thus meaningless.

tisonkun commented 5 years ago

Briefly, could you update the pull request to replace dummy doc with meaningful javadoc?

kennethvt437 commented 5 years ago

I was hoping the person who wrote the methods could add meaningful content to the javadocs, since I can't really tell what the methods do or the parameters mean just from this file.

tisonkun commented 5 years ago

@kennethvt437 if so, maybe it is better to open an issue instead of open a dummy pull request. What do you think?

kennethvt437 commented 5 years ago

Oh, okay. Next time if I see something like this I'll open an issue

tisonkun commented 5 years ago

Could you please then close this one?