Enhanced description of cfactor parameter

Brandon Heiner · Brandon Heiner · commit 5021128e81b1 · 2021-06-22T12:56:40.000-06:00
diff --git a/vpr/src/base/place_and_route.cpp b/vpr/src/base/place_and_route.cpp
@@ -461,7 +461,7 @@ t_chan_width init_chan(int cfactor, t_chan_width_dist chan_width_dist, t_graph_t
  * @brief Computes the channel width and adjusts it to be an an even number if unidirectional 
  *        since unidirectional graphs need to have paired wires.
  * 
- *   @param cfactor                 Channel width factor.
+ *   @param cfactor                 Channel width factor: multiplier on the channel width distribution (usually the number of tracks in the widest channel).
  *   @param chan_dist               Channel width distribution.
  *   @param x                       The distance (between 0 and 1) we are across the chip.
  *   @param separation              The distance between two channels in the 0 to 1 coordinate system.

Original file line number	Diff line number	Diff line change
`@@ -461,7 +461,7 @@ t_chan_width init_chan(int cfactor, t_chan_width_dist chan_width_dist, t_graph_t`
`461`	`461`	`* @brief Computes the channel width and adjusts it to be an an even number if unidirectional`
`462`	`462`	`* since unidirectional graphs need to have paired wires.`
`463`	`463`	`*`
`464`		`- * @param cfactor Channel width factor.`
	`464`	`+ * @param cfactor Channel width factor: multiplier on the channel width distribution (usually the number of tracks in the widest channel).`
`465`	`465`	`* @param chan_dist Channel width distribution.`
`466`	`466`	`* @param x The distance (between 0 and 1) we are across the chip.`
`467`	`467`	`* @param separation The distance between two channels in the 0 to 1 coordinate system.`