vtr-verilog-to-routing icon indicating copy to clipboard operation
vtr-verilog-to-routing copied to clipboard

Published 20 hours ago • verified publisher icon verilog-to-routing

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

Open vaughnbetz opened this issue 2 years ago • 2 comments

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 avatar Aug 27 '21 21:08 vaughnbetz