Skip to content

Commit 2e8a11d

Browse files
update doxygen for t_chan
1 parent c684d89 commit 2e8a11d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

libs/libarchfpga/src/physical_types.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1541,9 +1541,11 @@ enum class e_stat {
15411541
};
15421542

15431543
/// @brief Parameters describing a channel distribution.
1544+
/// @note If detailed routing is performed, only a uniform (all channels in a given direction are the same width)
1545+
/// distribution is supported.
15441546
struct t_chan {
15451547
e_stat type; ///< Distribution type
1546-
float peak; ///< Peak value
1548+
float peak; ///< Peak value. For a UNIFORM distribution, this is the value for all channels (in a given direction).
15471549
float width; ///< Standard deviation (Gaussian)
15481550
float xpeak; ///< Peak location (Gaussian)
15491551
float dc; ///< DC offset (Gaussian, pulse)

0 commit comments

Comments
 (0)