Skip to content

Commit 088f075

Browse files
doxygen comment for find_pin_nodes_at_side()
1 parent 17d5145 commit 088f075

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

libs/librrgraph/src/base/rr_spatial_lookup.h

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,17 +129,15 @@ class RRSpatialLookup {
129129
e_rr_type rr_type,
130130
int ptc) const;
131131

132-
/**
133-
* @brief Returns all matching nodes on all the sides at a specific grid tile (layer,x,y) location.
134-
*
135-
* As this is applicable to grid pins, the type of nodes are limited to SOURCE/SINK/IPIN/OPIN/MUX
136-
*/
132+
/// @brief Returns all matching nodes on all the sides at a specific grid tile (layer,x,y) location.
133+
/// As this is applicable to grid pins, the type of nodes are limited to SOURCE/SINK/IPIN/OPIN/MUX
137134
std::vector<RRNodeId> find_grid_nodes_at_all_sides(int layer,
138135
int x,
139136
int y,
140137
e_rr_type rr_type) const;
141138

142-
139+
/// @brief Returns all pin nodes on the given side at a specific grid tile (layer,x,y) location.
140+
/// As this is applicable to grid pins, the type of nodes are limited to IPIN/OPIN
143141
std::vector<RRNodeId> find_pin_nodes_at_side(int layer,
144142
int x,
145143
int y,
@@ -148,7 +146,7 @@ class RRSpatialLookup {
148146

149147
/* -- Mutators -- */
150148
public:
151-
/** @brief Reserve the memory for a list of nodes at (layer, x, y) location with given type and side */
149+
/// @brief Reserve the memory for a list of nodes at (layer, x, y) location with given type and side
152150
void reserve_nodes(int layer,
153151
int x,
154152
int y,

0 commit comments

Comments
 (0)