clean some doxygen comments

Author: soheilshahrouz

libs/libarchfpga/src/switchblock_types.h

@@ -64,10 +64,7 @@ inline const std::unordered_map<char, e_side> CHAR_SIDE_MAP = {
 constexpr std::array<e_side, NUM_2D_SIDES> TOTAL_2D_SIDES = {{TOP, RIGHT, BOTTOM, LEFT}};                     // Set of all side orientations
 constexpr std::array<const char*, NUM_2D_SIDES> TOTAL_2D_SIDE_STRINGS = {{"TOP", "RIGHT", "BOTTOM", "LEFT"}}; // String versions of side orientations
 
-/**
- * @brief Specifies what part of the FPGA a custom switchblock should be built in (i.e. perimeter, core, everywhere)
- * 
- */
+/// @brief Specifies what part of the FPGA a custom switchblock should be built in (i.e. perimeter, core, everywhere)
 enum class e_sb_location {
     E_PERIMETER = 0,
     E_CORNER,
@@ -96,7 +93,6 @@ struct t_sb_loc_spec {
 
 /**
  * @brief represents a connection between two sides of a switchblock
- * 
  */
 class SBSideConnection {
   public:
@@ -141,7 +137,6 @@ enum class e_switch_point_order {
 
 /**
  * @brief A collection of switchpoints associated with a segment
- * 
  */
 struct t_wire_switchpoints {
     std::string segment_name;      ///< The type of segment
@@ -150,7 +145,6 @@ struct t_wire_switchpoints {
 
 /**
  * @brief Used to list information about a set of track segments that should connect through a switchblock
- * 
  */
 struct t_wireconn_inf {
     std::vector<t_wire_switchpoints> from_switchpoint_set;                     ///< The set of segment/wirepoints representing the 'from' set (union of all t_wire_switchpoints in vector)

libs/librrgraph/src/base/rr_graph_view.h

@@ -25,7 +25,10 @@
  * 5. A short (metal connection).
  * 
  * 
- * @note Despite the RRGraph containing millions of edges, there are only a few switch types. Therefore, all switch details, including R and C, are stored using a flyweight pattern (rr_switch_inf) rather than being directly embedded in the edge-related data of the RRGraph. Each edge stores the ID of its associated switch for easy lookup.
+ * @note Despite the RRGraph containing millions of edges, there are only a few switch types.
+ * Therefore, all switch details, including R and C, are stored using a flyweight pattern (rr_switch_inf)
+ * rather than being directly embedded in the edge-related data of the RRGraph.
+ * Each edge stores the ID of its associated switch for easy lookup.
  * 
  * 
  * \internal
@@ -225,21 +228,15 @@ class RRGraphView {
         return node_storage_.node_yhigh(node);
     }
 
-    /** @brief Return the layer num of a specified node.
-    */
-    // inline short node_layer(RRNodeId node) const {
-    //     return node_storage_.node_layer(node);
-    // }
-
+    /// @brief Returns the highest layer where a node is located at.
     inline short node_layer_high(RRNodeId node) const {
         return node_storage_.node_layer_high(node);
     }
 
+    /// @brief Returns the lowest layer where a node is located at.
     inline short node_layer_low(RRNodeId node) const {
         return node_storage_.node_layer_low(node);
     }
-
-
 
     /** 
      * @brief Return the bend start of a specified node.

vpr/src/route/rr_graph_generation/build_switchblocks.h

@@ -85,7 +85,7 @@ struct t_switchblock_edge {
     /// Destination wire ptc_num index in a channel
     short to_wire;
 
-    /// RR graph switch index that connects the source wire to the destination wire that connect two tracks in same layer
+    /// RR graph switch index that connects the source wire to the destination wire that connect two tracks
     short switch_ind;
 };