2.x: Improve BehaviorProcessor JavaDoc #5778
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A StackOverflow question prompted me to look at
BehaviorProcessor
to find it quite lacking of a detailed JavaDoc. This PR adds sentences and examples (I could think of) to it that explain the available features and behavior of thisProcessor
implementation.If the sentences are reviewed, the
BehaviorSubject
will be updated with the applicable information (i.e., everything minus backpressure related sentences).