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

Add Javadoc to configuration options in builder and spec interfaces / classes #7

Closed
lhotari opened this issue Sep 10, 2022 · 1 comment

Comments

@lhotari
Copy link
Member

lhotari commented Sep 10, 2022

As mentioned in #3, the configuration model in Reactive Java client is different from the ordinary Java client.

It is necessary to have clear Javadoc on all configuration options. There are multiple ways to configure the same option so it should be decided where to document the option and use links to refer to the primary place of documentation.

The proposal is to primarily document the options in the builder interface methods since that is the primary way for using the configuration api in code. The "spec" classes could contain the copy pasted title for the option and a link to the builder interface method for setting the option. The builder could contain more extensive explanations.

@lhotari
Copy link
Member Author

lhotari commented Dec 12, 2022

Javadocs have been added by many PRs created by @cbornet . I'm closing this issue.

@lhotari lhotari closed this as completed Dec 12, 2022
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

1 participant