Router Heap documentation update #2633
Closed
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.
Two changes to Router Heap documentation:
u
is protected and so doesn't appear in the documentation, but the descriptions of its accessors/mutators refer to it. Now, these functions' descriptions don't referenceu
and state explicitly what they do.HeapInterface
and/orKAryHeap
. Now, all pure virtual functions in these classes are protected, so they will only appear in the description of the child that implements them.