Added rr_graph_utils.h to documentation

Nathan Shreve · Nathan Shreve · commit 849e0b24dca9 · 2024-06-29T17:26:07.000-04:00
diff --git a/doc/src/api/vpr/rr_graph.rst b/doc/src/api/vpr/rr_graph.rst
@@ -35,3 +35,9 @@ RRSpatialLookup
    :project: librrgraph
    :members:
 
+rr_graph_utils
+---------------
+
+.. doxygenfile:: rr_graph_utils.h
+   :project: librrgraph
+   :sections: briefdescription detaileddescription func prototype user-defined public-func
diff --git a/libs/librrgraph/src/base/rr_graph_utils.cpp b/libs/librrgraph/src/base/rr_graph_utils.cpp
@@ -41,10 +41,6 @@ static void walk_cluster_recursive(const RRGraphView& rr_graph,
     }
 }
 
-/****************************************************************************
- * Find the switches interconnecting two nodes
- * Return a vector of switch ids
- ***************************************************************************/
 std::vector<RRSwitchId> find_rr_graph_switches(const RRGraph& rr_graph,
                                                const RRNodeId& from_node,
                                                const RRNodeId& to_node) {
diff --git a/libs/librrgraph/src/base/rr_graph_utils.h b/libs/librrgraph/src/base/rr_graph_utils.h
@@ -44,6 +44,8 @@ struct t_cluster_pin_chain {
 
 /**
 * @brief Get node-to-node switches in a RRGraph
+ *
+ * @return A vector of switch ids
 * */
 std::vector<RRSwitchId> find_rr_graph_switches(const RRGraph& rr_graph,
                                                const RRNodeId& from_node,

Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,6 @@ static void walk_cluster_recursive(const RRGraphView& rr_graph,`
`41`	`41`	`}`
`42`	`42`	`}`
`43`	`43`
`44`		`-/****************************************************************************`
`45`		`- * Find the switches interconnecting two nodes`
`46`		`- * Return a vector of switch ids`
`47`		`- ***************************************************************************/`
`48`	`44`	`std::vector<RRSwitchId> find_rr_graph_switches(const RRGraph& rr_graph,`
`49`	`45`	`const RRNodeId& from_node,`
`50`	`46`	`const RRNodeId& to_node) {`