Skip to content

KAFKA-3440: update JavaDoc#1287

Closed
mjsax wants to merge 3 commits into
apache:trunkfrom
mjsax:kafka-3440-JavaDoc
Closed

KAFKA-3440: update JavaDoc#1287
mjsax wants to merge 3 commits into
apache:trunkfrom
mjsax:kafka-3440-JavaDoc

Conversation

@mjsax
Copy link
Copy Markdown
Member

@mjsax mjsax commented Apr 28, 2016

  • add class doc for KTable, KStream, JoinWindows
  • add missing @return tags

@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Apr 28, 2016

@guozhangwang @miguno @enothereska Please review.

I guess this should get merged last. Might need to rebase after #1277 and #1250 got merged.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Apr 29, 2016

@miguno @guozhangwang @enothereska Just updated this.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"The time... or both." This may be confusing for developers as it seems they can set the window size parameter as negative values. I recommend removing this sentence as the follow-up example is sufficient.

mjsax added 3 commits April 29, 2016 17:58
- add class doc for KTable, KStream, JoinWindows
- add missing @return tags
@mjsax mjsax force-pushed the kafka-3440-JavaDoc branch from 1e4033d to 04364aa Compare April 29, 2016 16:17
@mjsax
Copy link
Copy Markdown
Member Author

mjsax commented Apr 29, 2016

@guozhangwang Just updated this PR. Addressing your comments and rebased to latest trunk.

@miguno
Copy link
Copy Markdown
Contributor

miguno commented Apr 29, 2016

Thanks for the patience, @mjsax. LGTM!

@ewencp
Copy link
Copy Markdown
Contributor

ewencp commented Apr 29, 2016

LGTM

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 this pull request may close these issues.

4 participants