Skip to content

Add Doxygen-style comments to RRGraphView and RRGraphBuilder, and make new VPR API tab #1834

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

Open
vaughnbetz opened this issue Aug 27, 2021 · 2 comments
Assignees

Comments

@vaughnbetz
Copy link
Contributor

We have nice new rr-graph APIs, so we should auto-generate API documentation on them.

Proposed Behaviour

New RRGraphView and RRGraphBuilder tabs on the vtr api tab in read the docs. Also should add some high-level comments (if they aren't there already) explaining exactly when each of these should be used.

Current Behaviour

Good comments, but I don't think they're doxygen-compatible and we don't build docs on them.

Possible Solution

Reformat comments to be doxygen-compatible, and add to the docs page.

Context

The comments and use of these classes will be more understandable if they're on doxygen.

@vaughnbetz
Copy link
Contributor Author

Cleaning up my old issues! @tangxifan : This all looks good, but it would be good if the RRGraphView class had a high level comment on what it is used for that showed up in the documentation. RRGraphBuilder and RRGraphSpatialLookup already have those high level comments.

@tangxifan
Copy link
Contributor

@vaughnbetz No problem. I will work on this.

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

2 participants