[vpr][base] remove var from doxygen comment

Author: amin1377

libs/libarchfpga/src/physical_types.h

@@ -1604,98 +1604,98 @@ enum e_Fc_type {
  * used if the route_type is DETAILED.  [0 .. det_routing_arch.num_segment]
  */
 struct t_segment_inf {
-    /** @var name
+    /**
      *  @brief The name of the segment type 
      */
     std::string name;
 
-    /** @var frequency
+    /**
      *  @brief ratio of tracks which are of this segment type. 
      */
     int frequency;
 
-    /** @var length
+    /**
      *  @brief Length (in clbs) of the segment. 
      */
     int length;
 
-    /** @var arch_wire_switch
+    /**
      *  @brief Index of the switch type that connects other wires to this segment. 
      * Note that this index is in relation to the switches from the architecture file, 
      * not the expanded list of switches that is built at the end of build_rr_graph. 
      */
     short arch_wire_switch;
 
-    /** @var arch_opin_switch
+    /**
      *  @brief Index of the switch type that connects output pins to this segment. 
      * Note that this index is in relation to the switches from the architecture file, 
      * not the expanded list of switches that is built at the end of build_rr_graph. 
      */
     short arch_opin_switch;
 
-    /** @var arch_wire_switch_dec
+    /**
      *  @brief Same as arch_wire_switch but used only for decremental tracks if it is 
      * specified in the architecture file. If -1, this value was not set in the 
      * architecture file and arch_wire_switch should be used for "DEC_DIR" wire segments. 
      */
     short arch_wire_switch_dec = -1;
 
-    /** @var arch_opin_switch_dec
+    /**
      *  @brief Same as arch_opin_switch but used only for decremental tracks if 
      * it is specified in the architecture file. If -1, this value was not set in 
      * the architecture file and arch_opin_switch should be used for "DEC_DIR" wire segments. 
      */
     short arch_opin_switch_dec = -1;
 
-    /** @var arch_opin_between_dice_switch
+    /**
      *  @brief Index of the switch type that connects output pins (OPINs) to this 
      * segment from another die (layer). Note that this index is in relation to 
      * the switches from the architecture file, not the expanded list of switches 
      * that is built at the end of build_rr_graph. 
      */
     short arch_inter_die_switch = -1;
 
-    /** @var frac_cb
+    /**
      *  @brief The fraction of logic blocks along its length to which this segment can connect. 
      * (i.e. internal population). 
      */
     float frac_cb;
 
-    /** @var frac_sb
+    /**
      *  @brief The fraction of the length + 1 switch blocks along the segment to which the segment can connect. 
      * Segments that aren't long lines must connect to at least two switch boxes. 
      */
     float frac_sb;
 
     bool longline;
 
-    /** @var Rmetal
+    /**
      *  @brief The resistance of a routing track, per unit logic block length. */
     float Rmetal;
 
-    /** @var Cmetal
+    /**
      *  @brief The capacitance of a routing track, per unit logic block length. */
     float Cmetal;
 
     enum e_directionality directionality;
 
-    /** @var parallel_axis
+    /**
      *  @brief Defines what axis the segment is parallel to. See e_parallel_axis 
      * comments for more details on the values. 
      */
     enum e_parallel_axis parallel_axis;
 
-    /** @var cb
+    /**
      *  @brief A vector of booleans indicating whether the segment can connect to a logic block. 
      */
     std::vector<bool> cb;
 
-    /** @var sb
+    /**
      *  @brief A vector of booleans indicating whether the segment can connect to a switch block. 
      */
     std::vector<bool> sb;
 
-    /** @var seg_index
+    /**
      *  @brief The index of the segment as stored in the appropriate Segs list.
      * Upon loading the architecture, we use this field to keep track of the 
      * segment's index in the unified segment_inf vector. This is useful when 
@@ -1704,7 +1704,7 @@ struct t_segment_inf {
      */
     int seg_index;
 
-    /** @var res_type
+    /**
      *  @brief Determines the routing network to which the segment belongs.
      *  Possible values are:
      *   - GENERAL: The segment is part of the general routing resources.

vpr/src/base/vpr_types.h

@@ -1361,93 +1361,93 @@ struct t_det_routing_arch {
  * @brief Lists detailed information about segmentation.  [0 .. W-1].
  */
 struct t_seg_details {
-    /** @var length
+    /**
      *  @brief Length (in clbs) of the segment. 
      */
     int length = 0;
 
-    /** @var start
+    /**
      *  @brief Index at which a segment starts in channel 0. 
      */
     int start = 0;
 
-    /** @var longline
+    /**
      *  @brief True if this segment spans the entire channel.
      */
     bool longline = false;
 
-    /** @var sb
+    /**
      *  @brief [0..length]: true for every channel intersection, relative to the 
      *  segment start, at which there is a switch box.
      */
     std::unique_ptr<bool[]> sb;
 
-    /** @var cb
+    /**
      *  @brief [0..length]: true for every logic block along the segment at
      *  which there is a connection box.
      */
     std::unique_ptr<bool[]> cb;
 
-    /** @var arch_wire_switch
+    /**
      *  @brief Index of the switch type that connects other wires to this segment.
      *  Note that this index is in relation to the switches from the architecture 
      *  file, not the expanded list of switches that is built at the end of build_rr_graph.
      */
     short arch_wire_switch = 0;
 
-    /** @var arch_opin_switch
+    /**
      *  @brief Index of the switch type that connects output pins (OPINs) *to* this segment.
      *  Note that this index is in relation to the switches from the architecture 
      *  file, not the expanded list of switches that is built at the end of build_rr_graph.
      */
     short arch_opin_switch = 0;
 
-    /** @var arch_opin_between_dice_switch
+    /**
      *  @brief Index of the switch type that connects output pins (OPINs) *to* this segment 
      *  from *another dice*. Note that this index is in relation to the switches from the 
      *  architecture file, not the expanded list of switches that is built at the end of 
      *  build_rr_graph.
      */
     short arch_inter_die_switch = 0;
 
-    /** @var Rmetal
+    /**
      *  @brief Resistance of a routing track, per unit logic block length.
      */
     float Rmetal = 0;
 
-    /** @var Cmetal
+    /**
      *  @brief Capacitance of a routing track, per unit logic block length.
      */
     float Cmetal = 0;
 
     bool twisted = false;
 
-    /** @var direction
+    /**
      *  @brief Direction of the segment.
      */
     enum Direction direction = Direction::NONE;
 
-    /** @var group_start
+    /**
      *  @brief Index of the first logic block in the group.
      */
     int group_start = 0;
 
-    /** @var group_size
+    /**
      *  @brief Size of the group.
      */
     int group_size = 0;
 
-    /** @var seg_start
+    /**
      *  @brief Index of the first logic block in the segment.
      */
     int seg_start = 0;
 
-    /** @var seg_end
+    /**
      *  @brief Index of the last logic block in the segment.
      */
     int seg_end = 0;
 
-    /** @var index
+    /**
      *  @brief index of the segment type used for this track.
      *  Note that this index will store the index of the segment
      *  relative to its **parallel** segment types, not all segments
@@ -1462,19 +1462,19 @@ struct t_seg_details {
      */
     int index = 0;
 
-    /** @var abs_index
+    /**
      *  @brief index is relative to the segment_inf vec as stored in device_ctx.
      *  Note that the above vector is **unifies** both x-parallel and
      *  y-parallel segments and is loaded up originally in read_xml_arch_file.cpp
      */
     int abs_index = 0;
 
-    /** @var Cmetal_per_m
+    /**
      *  @brief Used for power
      */
     float Cmetal_per_m = 0;
 
-    /** @var type_name
+    /**
      *  @brief Name of the segment type.
      */
     std::string type_name;