Skip to content

Commit e7d2255

Browse files
committed
[VPR] Reworked code comments by fixing typo and remove TODO items from Doxygen comments
1 parent 0fbc84b commit e7d2255

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

vpr/src/device/rr_graph_builder.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* - node_lookup: store a fast look-up for the nodes
1111
*
1212
* @note
13-
* - This is the only data structre allowed to modify a routing resource graph
13+
* - This is the only data structure allowed to modify a routing resource graph
1414
*
1515
*/
1616
#include "rr_graph_storage.h"

vpr/src/device/rr_spatial_lookup.h

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@ class RRSpatialLookup {
133133
*
134134
* @note a node added with this call will not create a node in the rr_graph_storage node list
135135
* You MUST add the node in the rr_graph_storage so that the node is valid
136-
*
136+
*/
137+
/*
137138
* TODO: Consider to try to return a reference to *this so that we can do chain calls
138139
* - .add_node(...)
139140
* - .add_node(...)
@@ -171,7 +172,8 @@ class RRSpatialLookup {
171172
*
172173
* @note currently this function only accepts SOURCE/SINK nodes. May unlock for the other types
173174
* depending on needs
174-
*
175+
*/
176+
/*
175177
* TODO: Consider to make a high-level API to duplicate the nodes for large blocks.
176178
* Then this API can become a private one
177179
* For example,
@@ -196,7 +198,8 @@ class RRSpatialLookup {
196198
* This function will keep any existing data
197199
*
198200
* @note Strongly recommend to use when the sizes of dimensions are deterministic
199-
*
201+
*/
202+
/*
200203
* TODO: should have a reserve function but vtd::ndmatrix does not have such API
201204
* as a result, resize can be an internal one while reserve function is a public mutator
202205
*/

0 commit comments

Comments
 (0)