diff options
author | Martin Braun <martin.braun@ettus.com> | 2021-04-01 14:32:25 +0200 |
---|---|---|
committer | Aaron Rossetto <aaron.rossetto@ni.com> | 2021-04-19 14:44:05 -0500 |
commit | 2fb53be084c89a55d800145029ae08d021382758 (patch) | |
tree | fa8fd9269962ac1c9cdb7202d92a009f1d499e49 /mpm | |
parent | 5bc851ed9cb5270edaa8fb479f55b3894d7cb81c (diff) | |
download | uhd-2fb53be084c89a55d800145029ae08d021382758.tar.gz uhd-2fb53be084c89a55d800145029ae08d021382758.tar.bz2 uhd-2fb53be084c89a55d800145029ae08d021382758.zip |
uhd: Update all headers for setters on multi_usrp re coerce/throw
Our APIs are not consistent when it comes to handling invalid settings.
Some setting (like antenna, LO name, ...) will trigger an exception when
invalid. Other settings (gain, frequency, clock rate) will get coerced
to a valid value.
This behaviour does make sense for the most part (it is more intuitive
that 81 dB gets coerced to 80 dB if that's the maximum, but coercing an
invalid antenna value like "RX1" has no clear alternative). And in any
case, this is the behaviour that UHD has always had.
In this commit, all Doxygen headers in multi_usrp are updated to exactly
describe their behaviour (coerce or throw).
Diffstat (limited to 'mpm')
0 files changed, 0 insertions, 0 deletions