Skip to content

Commit 0d96487

Browse files
committed
[VPR] Adapt Doxygen-style when commenting APIs for RRGraphBuilder-related data structures
1 parent b860481 commit 0d96487

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

vpr/src/device/rr_spatial_lookup.h

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ class RRSpatialLookup {
3030

3131
/* -- Accessors -- */
3232
public:
33-
/* Returns the index of the specified routing resource node.
33+
/**
34+
* Returns the index of the specified routing resource node.
3435
* - (x, y) are the grid location within the FPGA
3536
* - rr_type specifies the type of resource,
3637
* - ptc gives a unique number of resources of that type (e.g. CHANX) at that (x,y).
@@ -64,7 +65,8 @@ class RRSpatialLookup {
6465

6566
/* -- Mutators -- */
6667
public:
67-
/* Register a node in the fast look-up
68+
/**
69+
* Register a node in the fast look-up
6870
* - You must have a valid node id to register the node in the lookup
6971
* - (x, y) are the coordinate of the node to be indexable in the fast look-up
7072
* - type is the type of a node
@@ -90,20 +92,23 @@ class RRSpatialLookup {
9092
int ptc,
9193
e_side side);
9294

93-
/* Mirror the last dimension of a look-up, i.e., a list of nodes, from a source coordinate to
95+
/**
96+
* Mirror the last dimension of a look-up, i.e., a list of nodes, from a source coordinate to
9497
* a destination coordinate.
9598
* This function is mostly need by SOURCE and SINK nodes which are indexable in multiple locations.
9699
* Considering a bounding box (x, y)->(x + width, y + height) of a multi-height and multi-width grid,
97100
* SOURCE and SINK nodes are indexable in any location inside the boundry.
98101
*
99-
* Note: currently this function only accept SOURCE/SINK nodes. May unlock for other depending on needs
102+
* Note: currently this function only accepts SOURCE/SINK nodes. May unlock for the other types
103+
* depending on needs
100104
*/
101105
void mirror_nodes(const vtr::Point<int>& src_coord,
102106
const vtr::Point<int>& des_coord,
103107
t_rr_type type,
104108
e_side side);
105109

106-
/* Resize three dimensions of the lookup under a given type of node to be memory efficient
110+
/**
111+
* Resize three dimensions of the lookup under a given type of node to be memory efficient
107112
* This function is called to expand the matrix when x, y or side
108113
* when one or more of them beyond current capacity
109114
*

0 commit comments

Comments
 (0)