src/rig.c: Add comments to clarify both mode and width must be supplied

pull/771/head
Wouter van Gulik 2021-08-21 21:59:02 +02:00
rodzic d1bfa0172f
commit 84108f9613
1 zmienionych plików z 3 dodań i 0 usunięć

Wyświetl plik

@ -2297,6 +2297,9 @@ int HAMLIB_API rig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
* The value stored at \a mode location equals RIG_MODE_NONE when the current
* mode of the VFO is not defined (e.g. blank memory).
*
* Note that if either \a mode or \a width is NULL, -RIG_EINVAL is returned.
* Both must be given even if only one is actually wanted.
*
* \RETURNFUNC(RIG_OK) if the operation has been successful, otherwise
* a negative value if an error occurred (in which case, cause is
* set appropriately).