Skip to content

Router Heap documentation update #2633

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

Closed

Conversation

nedsels
Copy link
Contributor

@nedsels nedsels commented Jun 28, 2024

Two changes to Router Heap documentation:

  1. 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 reference u and state explicitly what they do.
  2. There are duplicate descriptions for public pure virtual functions inherited from HeapInterface and/or KAryHeap. Now, all pure virtual functions in these classes are protected, so they will only appear in the description of the child that implements them.

@github-actions github-actions bot added VPR VPR FPGA Placement & Routing Tool lang-cpp C/C++ code labels Jun 28, 2024
@nedsels nedsels closed this Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lang-cpp C/C++ code VPR VPR FPGA Placement & Routing Tool
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant