kopia lustrzana https://github.com/Hamlib/Hamlib
Fix sign of return values Doxygen comments
All RIG_E* constants are negated when returned.
Fied with:
perl -pe 's/return RIG_E/return -RIG_E/' -i src/vent.c
perl -pe 's/retval RIG_E/retval -RIG_E/g' -i $(grep -lEr "retval RIG_E" --include=*.{c,h})
pull/1751/head
Daniele Forsi IU5HKX
rodzic
72bde6e131
commit
721b81d9be
|
|
@ -102,7 +102,7 @@ static const struct confparams ampfrontend_serial_cfg_params[] =
|
|||
* \return RIG_OK or a **negative value** error.
|
||||
*
|
||||
* \retval RIG_OK TOK_... value set successfully.
|
||||
* \retval RIG_EINVAL TOK_.. value not set.
|
||||
* \retval -RIG_EINVAL TOK_.. value not set.
|
||||
*
|
||||
* \sa frontamp_get_conf()
|
||||
*/
|
||||
|
|
@ -365,7 +365,7 @@ int frontamp_set_conf(AMP *amp, hamlib_token_t token, const char *val)
|
|||
* \return RIG_OK or a **negative value** on error.
|
||||
*
|
||||
* \retval RIG_OK TOK_... value queried successfully.
|
||||
* \retval RIG_EINVAL TOK_.. value not queried.
|
||||
* \retval -RIG_EINVAL TOK_.. value not queried.
|
||||
*
|
||||
* \sa frontamp_set_conf()
|
||||
*/
|
||||
|
|
@ -517,7 +517,7 @@ int frontamp_get_conf2(AMP *amp, hamlib_token_t token, char *val, int val_len)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The \a cfunc action completed successfully.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent or \a cfunc is NULL.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent or \a cfunc is NULL.
|
||||
*/
|
||||
int HAMLIB_API amp_token_foreach(AMP *amp,
|
||||
int (*cfunc)(const struct confparams *,
|
||||
|
|
@ -673,8 +673,8 @@ hamlib_token_t HAMLIB_API amp_token_lookup(AMP *amp, const char *name)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The parameter was set successfully.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent or \a token is invalid.
|
||||
* \retval RIG_ENAVAIL amp_caps#set_conf() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent or \a token is invalid.
|
||||
* \retval -RIG_ENAVAIL amp_caps#set_conf() capability is not available.
|
||||
*
|
||||
* \sa amp_get_conf()
|
||||
*/
|
||||
|
|
@ -729,8 +729,8 @@ int HAMLIB_API amp_set_conf(AMP *amp, hamlib_token_t token, const char *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Querying the parameter was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_conf() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_conf() capability is not available.
|
||||
*
|
||||
* \sa amp_set_conf()
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -304,7 +304,7 @@ AMP *HAMLIB_API amp_init(amp_model_t amp_model)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Communication channel successfully opened.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
*
|
||||
* \sa amp_init(), amp_close()
|
||||
*/
|
||||
|
|
@ -463,7 +463,7 @@ int HAMLIB_API amp_open(AMP *amp)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Communication channel successfully closed.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
*
|
||||
* \sa amp_cleanup(), amp_open()
|
||||
*/
|
||||
|
|
@ -555,7 +555,7 @@ int HAMLIB_API amp_close(AMP *amp)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK #AMP handle successfully released.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
*
|
||||
* \sa amp_init(), amp_close()
|
||||
*/
|
||||
|
|
@ -602,8 +602,8 @@ int HAMLIB_API amp_cleanup(AMP *amp)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The reset command was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#reset() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#reset() capability is not available.
|
||||
*/
|
||||
int HAMLIB_API amp_reset(AMP *amp, amp_reset_t reset)
|
||||
{
|
||||
|
|
@ -639,8 +639,8 @@ int HAMLIB_API amp_reset(AMP *amp, amp_reset_t reset)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_freq() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_freq() capability is not available.
|
||||
*
|
||||
* \sa amp_set_freq()
|
||||
*/
|
||||
|
|
@ -679,8 +679,8 @@ int HAMLIB_API amp_get_freq(AMP *amp, freq_t *freq)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Setting the frequency was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#set_freq() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#set_freq() capability is not available.
|
||||
*
|
||||
* \sa amp_get_freq()
|
||||
*/
|
||||
|
|
@ -752,8 +752,8 @@ const char *HAMLIB_API amp_get_info(AMP *amp)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_level() capability is not available.
|
||||
*
|
||||
* \sa amp_set_ext_level()
|
||||
*/
|
||||
|
|
@ -789,8 +789,8 @@ int HAMLIB_API amp_set_level(AMP *amp, setting_t level, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_level() capability is not available.
|
||||
*
|
||||
* \sa amp_get_ext_level()
|
||||
*/
|
||||
|
|
@ -825,8 +825,8 @@ int HAMLIB_API amp_get_level(AMP *amp, setting_t level, value_t *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#set_ext_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#set_ext_level() capability is not available.
|
||||
*
|
||||
* \sa amp_set_level()
|
||||
*/
|
||||
|
|
@ -860,8 +860,8 @@ int HAMLIB_API amp_set_ext_level(AMP *amp, hamlib_token_t level, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_ext_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_ext_level() capability is not available.
|
||||
*
|
||||
* \sa amp_get_level()
|
||||
*/
|
||||
|
|
@ -898,8 +898,8 @@ int HAMLIB_API amp_get_ext_level(AMP *amp, hamlib_token_t level, value_t *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The requested power/standby state was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#set_powerstat() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#set_powerstat() capability is not available.
|
||||
*
|
||||
* \sa amp_get_powerstat()
|
||||
*/
|
||||
|
|
@ -935,8 +935,8 @@ int HAMLIB_API amp_set_powerstat(AMP *amp, powerstat_t status)
|
|||
* if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Querying the power/standby state was successful.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_powerstat() capability is not available.
|
||||
* \retval -RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL amp_caps#get_powerstat() capability is not available.
|
||||
*
|
||||
* \sa amp_set_powerstat()
|
||||
*/
|
||||
|
|
|
|||
12
src/cm108.c
12
src/cm108.c
|
|
@ -165,8 +165,8 @@ const char *get_usb_device_class_string(int device_class)
|
|||
* \return File descriptor, otherwise a **negative value** if an error
|
||||
* occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_EINVAL The port pathname is empty or no CM108 device detected.
|
||||
* \retval RIG_EIO The `open`(2) system call returned a **negative value**.
|
||||
* \retval -RIG_EINVAL The port pathname is empty or no CM108 device detected.
|
||||
* \retval -RIG_EIO The `open`(2) system call returned a **negative value**.
|
||||
*/
|
||||
int cm108_open(hamlib_port_t *port)
|
||||
{
|
||||
|
|
@ -263,9 +263,9 @@ int cm108_close(hamlib_port_t *port)
|
|||
* occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Setting or unsetting the PTT was successful.
|
||||
* \retval RIG_EINVAL The file descriptor is invalid or the PTT type is
|
||||
* \retval -RIG_EINVAL The file descriptor is invalid or the PTT type is
|
||||
* unsupported.
|
||||
* \retval RIG_EIO The `write`(2) system call returned a **negative value**.
|
||||
* \retval -RIG_EIO The `write`(2) system call returned a **negative value**.
|
||||
*/
|
||||
int cm108_ptt_set(hamlib_port_t *p, ptt_t pttx)
|
||||
{
|
||||
|
|
@ -347,8 +347,8 @@ int cm108_ptt_set(hamlib_port_t *p, ptt_t pttx)
|
|||
* occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Getting the PTT state was successful.
|
||||
* \retval RIG_ENIMPL Getting the state is not yet implemented.
|
||||
* \retval RIG_ENAVAIL Getting the state is not available for this PTT type.
|
||||
* \retval -RIG_ENIMPL Getting the state is not yet implemented.
|
||||
* \retval -RIG_ENAVAIL Getting the state is not available for this PTT type.
|
||||
*/
|
||||
int cm108_ptt_get(hamlib_port_t *p, ptt_t *pttx)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -577,7 +577,7 @@ int HAMLIB_API rig_set_spectrum_callback(RIG *rig, spectrum_cb_t cb,
|
|||
* \sa rig_get_trn()
|
||||
*
|
||||
* \deprecated This functionality has never worked correctly and it is now disabled in favor of new async data handling capabilities.
|
||||
* The command will always return RIG_EDEPRECATED until the command will be removed eventually.
|
||||
* The command will always return -RIG_EDEPRECATED until the command will be removed eventually.
|
||||
*/
|
||||
int HAMLIB_API rig_set_trn(RIG *rig, int trn)
|
||||
{
|
||||
|
|
@ -601,7 +601,7 @@ int HAMLIB_API rig_set_trn(RIG *rig, int trn)
|
|||
* \sa rig_set_trn()
|
||||
*
|
||||
* \deprecated This functionality has never worked correctly and it is now disabled in favor of new async data handling capabilities.
|
||||
* The command will always return RIG_EDEPRECATED until the command will be removed eventually.
|
||||
* The command will always return -RIG_EDEPRECATED until the command will be removed eventually.
|
||||
*/
|
||||
int HAMLIB_API rig_get_trn(RIG *rig, int *trn)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@
|
|||
* **negative value** which means an abnormal end,
|
||||
*
|
||||
* \retval RIG_OK All extension levels elements successfully processed.
|
||||
* \retval RIG_EINVAL \a amp or \a cfunc is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a amp or \a cfunc is NULL or inconsistent.
|
||||
*/
|
||||
int HAMLIB_API amp_ext_level_foreach(AMP *amp,
|
||||
int (*cfunc)(AMP *,
|
||||
|
|
@ -117,7 +117,7 @@ int HAMLIB_API amp_ext_level_foreach(AMP *amp,
|
|||
* **negative value** which means an abnormal end.
|
||||
*
|
||||
* \retval RIG_OK All extension parameters elements successfully processed.
|
||||
* \retval RIG_EINVAL \a amp or \a cfunc is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a amp or \a cfunc is NULL or inconsistent.
|
||||
*/
|
||||
int HAMLIB_API amp_ext_parm_foreach(AMP *amp,
|
||||
int (*cfunc)(AMP *,
|
||||
|
|
|
|||
|
|
@ -290,7 +290,7 @@ double HAMLIB_API dmmm2dec(int degrees, double minutes, double seconds, int sw)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The conversion was successful.
|
||||
* \retval RIG_EINVAL Either of the pointers are NULL.
|
||||
* \retval -RIG_EINVAL Either of the pointers are NULL.
|
||||
*
|
||||
* \sa dms2dec()
|
||||
*/
|
||||
|
|
@ -388,7 +388,7 @@ int HAMLIB_API dec2dms(double dec,
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The conversion was successful.
|
||||
* \retval RIG_EINVAL Either of the pointers are NULL.
|
||||
* \retval -RIG_EINVAL Either of the pointers are NULL.
|
||||
*
|
||||
* \sa dmmm2dec()
|
||||
*/
|
||||
|
|
@ -438,7 +438,7 @@ int HAMLIB_API dec2dmmm(double dec, int *degrees, double *minutes, int *sw)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The conversion was successful.
|
||||
* \retval RIG_EINVAL The QRA locator exceeds RR99xx99xx99 or exceeds length
|
||||
* \retval -RIG_EINVAL The QRA locator exceeds RR99xx99xx99 or exceeds length
|
||||
* limit--currently 1 to 6 lon/lat pairs--or is otherwise malformed.
|
||||
*
|
||||
* \bug The fifth pair ranges from aa to xx, there is another convention
|
||||
|
|
@ -531,7 +531,7 @@ int HAMLIB_API locator2longlat(double *longitude,
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The conversion was successful.
|
||||
* \retval RIG_EINVAL if \a locator is NULL or \a pair_count exceeds length
|
||||
* \retval -RIG_EINVAL if \a locator is NULL or \a pair_count exceeds length
|
||||
* limit. Currently 1 to 6 lon/lat pairs.
|
||||
*
|
||||
* \bug \a locator is not tested for overflow.
|
||||
|
|
@ -611,7 +611,7 @@ int HAMLIB_API longlat2locator(double longitude,
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The calculations were successful.
|
||||
* \retval RIG_EINVAL If a NULL pointer passed or \a lat and \a lon values
|
||||
* \retval -RIG_EINVAL If a NULL pointer passed or \a lat and \a lon values
|
||||
* exceed -90 to 90 or -180 to 180.
|
||||
*
|
||||
* \sa distance_long_path(), azimuth_long_path()
|
||||
|
|
|
|||
|
|
@ -984,8 +984,8 @@ RIG *HAMLIB_API rig_init(rig_model_t rig_model)
|
|||
* a negative value if an error occurred (in which case, cause is
|
||||
* set appropriately).
|
||||
*
|
||||
* \retval RIG_EINVAL \a rig is NULL or inconsistent.
|
||||
* \retval RIG_ENIMPL port type communication is not implemented yet.
|
||||
* \retval -RIG_EINVAL \a rig is NULL or inconsistent.
|
||||
* \retval -RIG_ENIMPL port type communication is not implemented yet.
|
||||
*
|
||||
* \sa rig_init(), rig_close()
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -133,7 +133,7 @@ static const struct confparams rotfrontend_serial_cfg_params[] =
|
|||
* \return RIG_OK or a **negative value** on error.
|
||||
*
|
||||
* \retval RIG_OK TOK_... value set successfully.
|
||||
* \retval RIG_EINVAL TOK_.. value not set.
|
||||
* \retval -RIG_EINVAL TOK_.. value not set.
|
||||
*
|
||||
* \sa frontrot_get_conf()
|
||||
*/
|
||||
|
|
@ -402,7 +402,7 @@ int frontrot_set_conf(ROT *rot, hamlib_token_t token, const char *val)
|
|||
* \return RIG_OK or a **negative value** on error.
|
||||
*
|
||||
* \retval RIG_OK TOK_... value queried successfully.
|
||||
* \retval RIG_EINVAL TOK_.. value not queried.
|
||||
* \retval -RIG_EINVAL TOK_.. value not queried.
|
||||
*
|
||||
* \sa frontrot_set_conf()
|
||||
*/
|
||||
|
|
@ -577,7 +577,7 @@ int frontrot_get_conf(ROT *rot, hamlib_token_t token, char *val, int val_len)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The \a cfunc action completed successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent or \a cfunc is NULL.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent or \a cfunc is NULL.
|
||||
*/
|
||||
int HAMLIB_API rot_token_foreach(ROT *rot,
|
||||
int (*cfunc)(const struct confparams *,
|
||||
|
|
@ -738,8 +738,8 @@ hamlib_token_t HAMLIB_API rot_token_lookup(ROT *rot, const char *name)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The parameter was set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent or \a token is invalid.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_conf() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent or \a token is invalid.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_conf() capability is not available.
|
||||
*
|
||||
* \sa rot_get_conf()
|
||||
*/
|
||||
|
|
@ -794,8 +794,8 @@ int HAMLIB_API rot_set_conf(ROT *rot, hamlib_token_t token, const char *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Querying the parameter was successful.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_conf() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_conf() capability is not available.
|
||||
*
|
||||
* \sa rot_set_conf()
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -87,7 +87,7 @@ static int rot_has_ext_token(ROT *rot, hamlib_token_t token)
|
|||
* value** which means an abnormal end.
|
||||
*
|
||||
* \retval RIG_OK All extension functions elements successfully processed.
|
||||
* \retval RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
*/
|
||||
int HAMLIB_API rot_ext_func_foreach(ROT *rot,
|
||||
int (*cfunc)(ROT *,
|
||||
|
|
@ -143,7 +143,7 @@ int HAMLIB_API rot_ext_func_foreach(ROT *rot,
|
|||
* **negative value** which means an abnormal end.
|
||||
*
|
||||
* \retval RIG_OK All extension levels elements successfully processed.
|
||||
* \retval RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
*/
|
||||
int HAMLIB_API rot_ext_level_foreach(ROT *rot,
|
||||
int (*cfunc)(ROT *,
|
||||
|
|
@ -199,7 +199,7 @@ int HAMLIB_API rot_ext_level_foreach(ROT *rot,
|
|||
* **negative value** which means an abnormal end.
|
||||
*
|
||||
* \retval RIG_OK All extension parameters elements successfully processed.
|
||||
* \retval RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a rot or \a cfunc is NULL or inconsistent.
|
||||
*/
|
||||
int HAMLIB_API rot_ext_parm_foreach(ROT *rot,
|
||||
int (*cfunc)(ROT *,
|
||||
|
|
|
|||
|
|
@ -69,8 +69,8 @@
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Setting the level was successful.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_level() capability is not available.
|
||||
*
|
||||
* \sa rot_has_set_level(), rot_get_level()
|
||||
*/
|
||||
|
|
@ -113,8 +113,8 @@ int HAMLIB_API rot_set_level(ROT *rot, setting_t level, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_level() capability is not available.
|
||||
*
|
||||
* \sa rot_has_get_level(), rot_set_level()
|
||||
*/
|
||||
|
|
@ -158,8 +158,8 @@ int HAMLIB_API rot_get_level(ROT *rot, setting_t level, value_t *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The parameter was set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_parm() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_parm() capability is not available.
|
||||
*
|
||||
* \sa rot_has_set_parm(), rot_get_parm()
|
||||
*/
|
||||
|
|
@ -198,8 +198,8 @@ int HAMLIB_API rot_set_parm(ROT *rot, setting_t parm, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The parameter was queried successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_parm() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_parm() capability is not available.
|
||||
*
|
||||
* \sa rot_has_get_parm(), rot_set_parm()
|
||||
*/
|
||||
|
|
@ -461,8 +461,8 @@ setting_t HAMLIB_API rot_has_set_func(ROT *rot, setting_t func)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The function was activated or deactivated successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_func() capability is not available or
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_func() capability is not available or
|
||||
* \a func is not supported.
|
||||
*
|
||||
* \sa rot_get_func()
|
||||
|
|
@ -505,8 +505,8 @@ int HAMLIB_API rot_set_func(ROT *rot, setting_t func, int status)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The function status was queried successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_func() capability is not available or
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_func() capability is not available or
|
||||
* \a func is not supported.
|
||||
*
|
||||
* \sa rot_set_func()
|
||||
|
|
@ -549,8 +549,8 @@ int HAMLIB_API rot_get_func(ROT *rot, setting_t func, int *status)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension level was set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_ext_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_ext_level() capability is not available.
|
||||
*
|
||||
* \sa rot_get_ext_level()
|
||||
*/
|
||||
|
|
@ -589,8 +589,8 @@ int HAMLIB_API rot_set_ext_level(ROT *rot, hamlib_token_t token, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension level was queried successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_ext_level() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_ext_level() capability is not available.
|
||||
*
|
||||
* \sa rot_set_ext_level()
|
||||
*/
|
||||
|
|
@ -633,8 +633,8 @@ int HAMLIB_API rot_get_ext_level(ROT *rot, hamlib_token_t token, value_t *val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension function status was set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_ext_func() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_ext_func() capability is not available.
|
||||
*
|
||||
* \sa rot_get_ext_func()
|
||||
*/
|
||||
|
|
@ -676,8 +676,8 @@ int HAMLIB_API rot_set_ext_func(ROT *rot, hamlib_token_t token, int status)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension function status was queried successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_ext_func() capability is not available or
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_ext_func() capability is not available or
|
||||
* \a token is not supported.
|
||||
*
|
||||
* \sa rot_set_ext_func()
|
||||
|
|
@ -719,8 +719,8 @@ int HAMLIB_API rot_get_ext_func(ROT *rot, hamlib_token_t token, int *status)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension parameter was set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_ext_parm() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_ext_parm() capability is not available.
|
||||
*
|
||||
* \sa rot_get_ext_parm()
|
||||
*/
|
||||
|
|
@ -757,8 +757,8 @@ int HAMLIB_API rot_set_ext_parm(ROT *rot, hamlib_token_t token, value_t val)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The extension parameter was queried successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_ext_parm() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_ext_parm() capability is not available.
|
||||
*
|
||||
* \sa rot_set_ext_parm()
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -364,8 +364,8 @@ ROT *HAMLIB_API rot_init(rot_model_t rot_model)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Communication channel successfully opened.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENIMPL Communication port type is not implemented yet.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENIMPL Communication port type is not implemented yet.
|
||||
*
|
||||
* \sa rot_init(), rot_close()
|
||||
*/
|
||||
|
|
@ -603,7 +603,7 @@ int HAMLIB_API rot_open(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Communication channel successfully closed.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
*
|
||||
* \sa rot_cleanup(), rot_open()
|
||||
*/
|
||||
|
|
@ -692,7 +692,7 @@ int HAMLIB_API rot_close(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK #ROT handle successfully released.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
*
|
||||
* \sa rot_init(), rot_close()
|
||||
*/
|
||||
|
|
@ -746,9 +746,9 @@ int HAMLIB_API rot_cleanup(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Either or both parameters set successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent \b or either \a azimuth
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent \b or either \a azimuth
|
||||
* or \a elevation is out of range for this rotator.
|
||||
* \retval RIG_ENAVAIL rot_caps#set_position() capability is not available.
|
||||
* \retval -RIG_ENAVAIL rot_caps#set_position() capability is not available.
|
||||
*
|
||||
* \sa rot_get_position()
|
||||
*/
|
||||
|
|
@ -819,8 +819,8 @@ int HAMLIB_API rot_set_position(ROT *rot,
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK Either or both parameters queried and stored successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_position() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_position() capability is not available.
|
||||
*
|
||||
* \sa rot_set_position()
|
||||
*/
|
||||
|
|
@ -880,8 +880,8 @@ int HAMLIB_API rot_get_position(ROT *rot,
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The rotator was parked successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#park() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#park() capability is not available.
|
||||
*
|
||||
*/
|
||||
int HAMLIB_API rot_park(ROT *rot)
|
||||
|
|
@ -917,8 +917,8 @@ int HAMLIB_API rot_park(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The rotator was stopped successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#stop() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#stop() capability is not available.
|
||||
*
|
||||
* \sa rot_move()
|
||||
*/
|
||||
|
|
@ -956,8 +956,8 @@ int HAMLIB_API rot_stop(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The rotator was reset successfully.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#reset() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#reset() capability is not available.
|
||||
*/
|
||||
int HAMLIB_API rot_reset(ROT *rot, rot_reset_t reset)
|
||||
{
|
||||
|
|
@ -995,8 +995,8 @@ int HAMLIB_API rot_reset(ROT *rot, rot_reset_t reset)
|
|||
* The \a speed is a value between 1 and 100 or #ROT_SPEED_NOCHANGE.
|
||||
*
|
||||
* \retval RIG_OK The rotator move was successful.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#move() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#move() capability is not available.
|
||||
*
|
||||
* \sa rot_stop()
|
||||
*/
|
||||
|
|
@ -1065,8 +1065,8 @@ const char *HAMLIB_API rot_get_info(ROT *rot)
|
|||
* value** if an error occurred (in which case, cause is set appropriately).
|
||||
*
|
||||
* \retval RIG_OK The query was successful.
|
||||
* \retval RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL rot_caps#get_status() capability is not available.
|
||||
* \retval -RIG_EINVAL \a rot is NULL or inconsistent.
|
||||
* \retval -RIG_ENAVAIL rot_caps#get_status() capability is not available.
|
||||
*/
|
||||
int HAMLIB_API rot_get_status(ROT *rot, rot_status_t *status)
|
||||
{
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue