Updating comment about API set_node_direction

Muhammad Haris Zafar · Muhammad Haris Zafar · commit 6e9f206ababc · 2021-09-28T12:54:06.000+05:00
diff --git a/vpr/src/device/rr_graph_builder.h b/vpr/src/device/rr_graph_builder.h
@@ -65,7 +65,7 @@ class RRGraphBuilder {
         node_storage_.set_node_coordinates(id, x1, y1, x2, y2);
     }
 
-    /** @brief Set the node direction */
+    /** @brief Set the node direction; The node direction is only available of routing channel nodes, such as x-direction routing tracks (CHANX) and y-direction routing tracks (CHANY). Otherwise the value contained in the field should be igonred. */
     inline void set_node_direction(RRNodeId id, Direction new_direction) {
         node_storage_.set_node_direction(id, new_direction);
     }

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ class RRGraphBuilder {`
`65`	`65`	`node_storage_.set_node_coordinates(id, x1, y1, x2, y2);`
`66`	`66`	`}`
`67`	`67`
`68`		`- /** @brief Set the node direction */`
	`68`	`+ /** @brief Set the node direction; The node direction is only available of routing channel nodes, such as x-direction routing tracks (CHANX) and y-direction routing tracks (CHANY). Otherwise the value contained in the field should be igonred. */`
`69`	`69`	`inline void set_node_direction(RRNodeId id, Direction new_direction) {`
`70`	`70`	`node_storage_.set_node_direction(id, new_direction);`
`71`	`71`	`}`