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 examples to Javadoc for Throwing*.of factory methods #28969

Closed
sbrannen opened this issue Aug 16, 2022 · 0 comments
Closed

Add examples to Javadoc for Throwing*.of factory methods #28969

sbrannen opened this issue Aug 16, 2022 · 0 comments
Assignees
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

The current Javadoc is technically correct, but it is not readily apparent how the methods are intended to be used.

In order to help developers understand how the Throwing*.of factory methods can be used, we should add an example or two to the Javadoc of each of the following methods.

  • ThrowingConsumer.of(ThrowingConsumer<T>)
  • ThrowingFunction.of(ThrowingFunction<T>)
  • ThrowingBiFunction.of(ThrowingBiFunction<T, U, R>)
  • ThrowingSupplier.of(ThrowingSupplier<T>)
@sbrannen sbrannen added type: documentation A documentation task in: core Issues in core modules (aop, beans, core, context, expression) labels Aug 16, 2022
@sbrannen sbrannen added this to the 6.0.0-M6 milestone Aug 16, 2022
@philwebb philwebb self-assigned this Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

2 participants