mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Merge pull request #653 from N0NB/doxygen_work 

Update Doxygen comments in
pull/658/head
Nate Bargmann 2021-04-07 11:12:35 -05:00 zatwierdzone przez GitHub
rodzic 74654e1877 716866bd45
commit e90147f83c
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
3 zmienionych plików z 315 dodań i 190 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

18
src/amp_settings.c
Wyświetl plik

@ -50,19 +50,23 @@
/** /**
* \brief Check retrieval ability of level settings. * \brief Check which level settings can be queried.
* *
* \param amp The #AMP handle. * \param amp The #AMP handle.
* \param level The level settings to check. * \param level The level settings bitmap.
* *
* Checks if an amplifier is capable of *getting* a level setting. Since the * Checks if an amplifier is capable of *getting* a level setting. Since the
* \a level is an OR'ed bitwise argument, more than one level can be checked * \a level is an OR'ed bitwise argument, more than one level can be checked
* at the same time. * at the same time.
* *
* EXAMPLE: \code if (amp_has_get_level(my_amp, AMP_LVL_SWR)) disp_SWR();\endcode * EXAMPLE:
* \code
* if (amp_has_get_level(my_amp, AMP_LVL_SWR))
* my_disp_SWR();
* \endcode
* *
* \return A bit map of supported level settings that can be retrieved, * \return A bit map of supported level settings that can be retrieved,
* otherwise 0 if none supported. * otherwise 0 if none supported or \a amp is NULL or inconsistent.
* *
* \sa amp_has_set_level(), amp_get_level() * \sa amp_has_set_level(), amp_get_level()
*/ */

2
src/amplifier.c
Wyświetl plik

@ -703,6 +703,8 @@ const char *HAMLIB_API amp_get_info(AMP *amp)
* *
* Query the \a val corresponding to the \a level. * Query the \a val corresponding to the \a level.
* *
* \note \a val can be any type defined by #value_t.
*
* \return RIG_OK if the operation was successful, otherwise a **negative * \return RIG_OK if the operation was successful, otherwise a **negative
* value** if an error occurred (in which case, cause is set appropriately). * value** if an error occurred (in which case, cause is set appropriately).
* *

485
src/rot_settings.c
Wyświetl plik

@ -1,17 +1,3 @@
/**
* \addtogroup rotator
* @{
*/
/**
* \file rot_settings.c
* \brief rotator func/level/parm interface
* \author Mikael Nousiainen
* \date 2020
*
* Hamlib interface is a frontend implementing wrapper functions.
*/
/* /*
* Hamlib Interface - rotator func/level/parm * Hamlib Interface - rotator func/level/parm
* Copyright (c) 2020 by Mikael Nousiainen * Copyright (c) 2020 by Mikael Nousiainen
@ -33,6 +19,22 @@
* *
*/ */
/**
* \addtogroup rotator
* @{
*/
/**
* \file rot_settings.c
* \brief Rotator functions/levels/parameters interface.
*
* \author Mikael Nousiainen
* \date 2020
*
* This Hamlib interface is a frontend implementing wrapper functions.
*/
#ifdef HAVE_CONFIG_H #ifdef HAVE_CONFIG_H
# include "config.h" # include "config.h"
#endif #endif
@ -58,18 +60,24 @@
/** /**
* \brief set a rotator level setting * \brief Set a rotator level to a given value.
* \param rig The rotator handle
* \param level The level setting
* \param val The value to set the level setting to
* *
* Sets the level of a setting. * \param rot The #ROT handle.
* The level value \a val can be a float or an integer. See #value_t * \param level The level to set.
* for more information. * \param val The value of the level.
* *
* \return RIG_OK if the operation has been successful, otherwise * Set \a level to \a val.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
* \note As this function calls rot_has_set_level(), this may be considered a
* higher level API.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_has_set_level(), rot_get_level() * \sa rot_has_set_level(), rot_get_level()
*/ */
@ -96,18 +104,24 @@ int HAMLIB_API rot_set_level(ROT *rot, setting_t level, value_t val)
/** /**
* \brief get the value of a level * \brief Query the value of a requested rotator level.
* \param rig The rotator handle
* \param level The level setting
* \param val The location where to store the value of \a level
* *
* Retrieves the value of a \a level. * \param rot The #ROT handle.
* The level value \a val can be a float or an integer. See #value_t * \param level The requested level.
* for more information. * \param val The variable to store the \a level value.
* *
* \return RIG_OK if the operation has been successful, otherwise * Query the \a val corresponding to the \a level.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
* \note As this function calls rot_has_get_level(), this may be considered a
* higher level API.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_has_get_level(), rot_set_level() * \sa rot_has_get_level(), rot_set_level()
*/ */
@ -135,18 +149,24 @@ int HAMLIB_API rot_get_level(ROT *rot, setting_t level, value_t *val)
/** /**
* \brief set a rotator parameter * \brief Set a rotator parameter to a given value.
* \param rig The rotator handle
* \param parm The parameter
* \param val The value to set the parameter
* *
* Sets a parameter. * \param rot The #ROT handle.
* The parameter value \a val can be a float or an integer. See #value_t * \param parm The parameter to set.
* for more information. * \param val The value of the parameter.
* *
* \return RIG_OK if the operation has been successful, otherwise * Sets \a parm to \a val.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
* \note As this function calls rot_has_set_parm(), this may be considered a
* higher level API.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_has_set_parm(), rot_get_parm() * \sa rot_has_set_parm(), rot_get_parm()
*/ */
@ -169,18 +189,24 @@ int HAMLIB_API rot_set_parm(ROT *rot, setting_t parm, value_t val)
/** /**
* \brief get the value of a parameter * \brief Query the value of a requested rotator parameter.
* \param rig The rotator handle
* \param parm The parameter
* \param val The location where to store the value of \a parm
* *
* Retrieves the value of a \a parm. * \param rot The #ROT handle.
* The parameter value \a val can be a float or an integer. See #value_t * \param parm The requested parameter.
* for more information. * \param val The variable to store the \a parm value.
* *
* \return RIG_OK if the operation has been successful, otherwise * Query the \a val corresponding to the \a parm.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
* \note As this function calls rot_has_get_parm(), this may be considered a
* higher level API.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_has_get_parm(), rot_set_parm() * \sa rot_has_get_parm(), rot_set_parm()
*/ */
@ -203,20 +229,28 @@ int HAMLIB_API rot_get_parm(ROT *rot, setting_t parm, value_t *val)
/** /**
* \brief check retrieval ability of level settings * \brief Check which rotator level settings can be queried.
* \param rig The rotator handle
* \param level The level settings
* *
* Checks if a rotator is capable of *getting* a level setting. * \param rot The #ROT handle.
* Since the \a level is an OR'ed bitwise argument, more than * \param level The level settings bitmap.
* one level can be checked at the same time.
* *
* EXAMPLE: if (rot_has_get_level(my_rig, RIG_LEVEL_SPEED)) * Checks if a rotator is capable of *getting* a level setting. Since
* \a level is an OR'ed bitwise argument, more than one level can be checked
* at the same time.
* *
* \return a bit map of supported level settings that can be retrieved, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_get_level(my_rot, ROT_LEVEL_SPEED))
* my_get_speed(&my_speed);
* \endcode
* *
* \sa rot_has_set_level(), rot_get_level() * \note As this function is called by rot_get_level(), this may be considered
* a lower level API.
*
* \return A bit map of supported level settings that can be retrieved,
* otherwise 0 if none supported or \a rot is NULL or inconsistent.
*
* \sa rot_get_level(), rot_has_set_level()
*/ */
setting_t HAMLIB_API rot_has_get_level(ROT *rot, setting_t level) setting_t HAMLIB_API rot_has_get_level(ROT *rot, setting_t level)
{ {
@ -234,20 +268,27 @@ setting_t HAMLIB_API rot_has_get_level(ROT *rot, setting_t level)
/** /**
* \brief check settable ability of level settings * \brief Query the rotator levels that may be set.
* \param rig The rotator handle
* \param level The level settings
* *
* Checks if a rotator can *set* a level setting. * \param rot The #ROT handle.
* Since the \a level is an OR'ed bitwise argument, more than * \param level The level settings bitmap.
* one level can be check at the same time.
* *
* EXAMPLE: if (rot_has_set_level(my_rig, ROT_LEVEL_SPEED)) * Checks if a rotator can *set* a level setting. Since \a level is an OR'ed
* bitwise argument, more than one level can be checked at the same time.
* *
* \return a bit map of supported level settings that can be set, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_set_level(my_rot, ROT_LEVEL_SPEED))
* my_set_speed(MEDIUM);
* \endcode
* *
* \sa rot_has_get_level(), rot_set_level() * \note As this function is called by rot_set_level(), this may be considered
* a lower level API.
*
* \return A bit map of supported level settings that can be set, otherwise 0
* if none supported or \a rot is NULL or inconsistent.
*
* \sa rot_set_level(), rot_has_get_level()
*/ */
setting_t HAMLIB_API rot_has_set_level(ROT *rot, setting_t level) setting_t HAMLIB_API rot_has_set_level(ROT *rot, setting_t level)
{ {
@ -264,20 +305,28 @@ setting_t HAMLIB_API rot_has_set_level(ROT *rot, setting_t level)
/** /**
* \brief check retrieval ability of parameter settings * \brief Check which rotator parameter settings can be queried.
* \param rig The rotator handle
* \param parm The parameter settings
* *
* Checks if a rotator is capable of *getting* a parm setting. * \param rot The #ROT handle.
* Since the \a parm is an OR'ed bitwise argument, more than * \param parm The parameter settings bitmap.
* one parameter can be checked at the same time.
* *
* EXAMPLE: if (rot_has_get_parm(my_rig, ROT_PARM_NONE)) * Checks if a rotator is capable of *getting* a parameter setting. Since
* \a parm is an OR'ed bitwise argument, more than one parameter can be
* checked at the same time.
* *
* \return a bit map of supported parameter settings that can be retrieved, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_get_parm(my_rot, ROT_PARM_NONE))
* my_get_parms(&parms);
* \endcode
* *
* \sa rot_has_set_parm(), rot_get_parm() * \note As this function is called by rot_get_parm(), this may be considered
* a lower level API.
*
* \return A bit map of supported parameter settings that can be retrieved,
* otherwise 0 if none supported or \a rot is NULL or inconsistent.
*
* \sa rot_get_parm(), rot_has_set_parm()
*/ */
setting_t HAMLIB_API rot_has_get_parm(ROT *rot, setting_t parm) setting_t HAMLIB_API rot_has_get_parm(ROT *rot, setting_t parm)
{ {
@ -293,20 +342,28 @@ setting_t HAMLIB_API rot_has_get_parm(ROT *rot, setting_t parm)
/** /**
* \brief check settable ability of parameter settings * \brief Query the rotator parameters that may be set.
* \param rig The rotator handle
* \param parm The parameter settings
* *
* Checks if a rotator can *set* a parameter setting. * \param rot The #ROT handle.
* Since the \a parm is an OR'ed bitwise argument, more than * \param parm The parameter settings bitmap.
* one parameter can be check at the same time.
* *
* EXAMPLE: if (rot_has_set_parm(my_rig, RIG_PARM_NONE)) * Checks if a rotator can *set* a parameter setting. Since \a parm is an
* OR'ed bitwise argument, more than one parameter can be checked at the same
* time.
* *
* \return a bit map of supported parameter settings that can be set, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_set_parm(my_rig, ROT_PARM_NONE))
* my_set_parm(parameter);
* \endcode
* *
* \sa rot_has_get_parm(), rot_set_parm() * \note As this function is called by rot_set_parm(), this may be considered
* a lower level API.
*
* \return A bit map of supported parameter settings that can be set,
* otherwise 0 if none supported or \a rot is NULL or inconsistent.
*
* \sa rot_set_parm(), rot_has_get_parm()
*/ */
setting_t HAMLIB_API rot_has_set_parm(ROT *rot, setting_t parm) setting_t HAMLIB_API rot_has_set_parm(ROT *rot, setting_t parm)
{ {
@ -322,20 +379,27 @@ setting_t HAMLIB_API rot_has_set_parm(ROT *rot, setting_t parm)
/** /**
* \brief check ability of rotator functions * \brief Check which rotator functions can be queried.
* \param rig The rotator handle
* \param func The functions
* *
* Checks if a rotator supports a set of functions. * \param rot The #ROT handle.
* Since the \a func is an OR'ed bitwise argument, more than * \param func The functions bitmap.
* one function can be checked at the same time.
* *
* EXAMPLE: if (rot_has_get_func(my_rig, RIG_FUNC_NONE)) * Checks if a rotator supports a set of functions. Since \a func is an OR'ed
* bitwise argument, more than one function can be checked at the same time.
* *
* \return a bit map of supported functions, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_get_func(my_rig, RIG_FUNC_NONE))
* do_something();
* \endcode
* *
* \sa rot_has_set_func(), rot_get_func() * \note As this function is called by rot_get_func(), this may be considered
* a lower level API.
*
* \return A bit map of supported functions that can be retrieved, otherwise 0
* if none supported or \a rot is NULL or inconsistent.
*
* \sa rot_get_func(), rot_has_set_func()
*/ */
setting_t HAMLIB_API rot_has_get_func(ROT *rot, setting_t func) setting_t HAMLIB_API rot_has_get_func(ROT *rot, setting_t func)
{ {
@ -352,18 +416,25 @@ setting_t HAMLIB_API rot_has_get_func(ROT *rot, setting_t func)
/** /**
* \brief check ability of rotator functions * \brief Query support of rotator functions.
* \param rig The rotator handle
* \param func The functions
* *
* Checks if a rotator supports a set of functions. * \param rot The #ROT handle.
* Since the \a func is an OR'ed bitwise argument, more than * \param func The functions bitmap.
* one function can be checked at the same time.
* *
* EXAMPLE: if (rot_has_set_func(my_rig, RIG_FUNC_NONE)) * Checks if a rotator supports a set of functions. Since \a func is an OR'ed
* bitwise argument, more than one function can be checked at the same time.
* *
* \return a bit map of supported functions, * EXAMPLE:
* otherwise 0 if none supported. * \code
* if (rot_has_set_func(my_rig, RIG_FUNC_NONE))
* do_this_func(my_func);
* \endcode
*
* \note As this function is called by rot_set_func(), this may be considered
* a lower level API.
*
* \return A bit map of supported functions that can be set, otherwise 0 if
* none supported or \a rot is NULL or inconsistent.
* *
* \sa rot_set_func(), rot_has_get_func() * \sa rot_set_func(), rot_has_get_func()
*/ */
@ -381,19 +452,25 @@ setting_t HAMLIB_API rot_has_set_func(ROT *rot, setting_t func)
/** /**
* \brief activate/de-activate functions of rotator * \brief Activate or deactivate functions of a rotator.
* \param rig The rotator handle
* \param func The function to activate
* \param status The status (on or off) to set to
* *
* Activate/de-activate a function of the radio. * \param rot The #ROT handle.
* \param func The function to activate or deactivate.
* \param status The status (On or Off) to set.
* *
* The \a status argument is a non null value for "activate", * Activate or deactivate a function of the rotator.
* "de-activate" otherwise, much as TRUE/FALSE definitions in C language.
* *
* \return RIG_OK if the operation has been successful, otherwise * The \a status argument is a value that is not NULL for "activate",
* a negative value if an error occurred (in which case, cause is * "deactivate" otherwise, much as TRUE or FALSE boolean definitions in the C
* set appropriately). * language.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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
* \a func is not supported.
* *
* \sa rot_get_func() * \sa rot_get_func()
*/ */
@ -420,20 +497,24 @@ int HAMLIB_API rot_set_func(ROT *rot, setting_t func, int status)
/** /**
* \brief get the status of functions of the rotator * \brief Query the status of functions of the rotator.
* \param rig The rotator handle
* \param func The function to get the status
* \param status The location where to store the function status
* *
* Retrieves the status (on/off) of a function of the rotator. * \param rot The #ROT handle.
* Upon return, \a status will hold the status of the function, * \param func The function to query the status.
* The value pointer to by the \a status argument is a non null * \param status The variable to store the function status.
* value for "on", "off" otherwise, much as TRUE/FALSE
* definitions in C language.
* *
* \return RIG_OK if the operation has been successful, otherwise * Retrieves the status (On or Off) of a function of the rotator. Upon
* a negative value if an error occurred (in which case, cause is * return, \a status will hold the status of the function. The value pointed
* set appropriately). * to by the \a status argument is not NULL for "On", or "Off" otherwise, much
* as TRUE or FALSE boolean definitions in the C language.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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
* \a func is not supported.
* *
* \sa rot_set_func() * \sa rot_set_func()
*/ */
@ -461,16 +542,22 @@ int HAMLIB_API rot_get_func(ROT *rot, setting_t func, int *status)
/** /**
* \brief set a rotator level extra parameter * \brief Set a rotator extension level to a given value.
* \param rig The rotator handle
* \param token The parameter
* \param val The value to set the parameter to
* *
* Sets an level extra parameter. * \param rot The #ROT handle.
* \param token The extension level token.
* \param val The value of the extension level.
* *
* \return RIG_OK if the operation has been successful, otherwise * Set extension level \a token to \a val.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_get_ext_level() * \sa rot_get_ext_level()
*/ */
@ -497,16 +584,20 @@ int HAMLIB_API rot_set_ext_level(ROT *rot, token_t token, value_t val)
/** /**
* \brief get the value of a level extra parameter * \brief Query the value of a requested rotator extension level.
* \param rig The rotator handle
* \param token The parameter
* \param val The location where to store the value of \a token
* *
* Retrieves the value of a level extra parameter associated with \a token. * \param rot The #ROT handle.
* \param token The extension level token.
* \param val The location where to store the value of \a token.
* *
* \return RIG_OK if the operation has been successful, otherwise * Query the \a val corresponding to the extension level \a token.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_set_ext_level() * \sa rot_set_ext_level()
*/ */
@ -533,16 +624,24 @@ int HAMLIB_API rot_get_ext_level(ROT *rot, token_t token, value_t *val)
/** /**
* \brief set a rotator function extra parameter * \brief Activate or deactivate extension functions of a rotator.
* \param rig The rotator handle
* \param token The parameter
* \param status The value to set the parameter to
* *
* Sets a function extra parameter. * \param rot The #ROT handle.
* \param token The extension function to activate or deactivate.
* \param status The status (On or Off) to set.
* *
* \return RIG_OK if the operation has been successful, otherwise * Activate or deactivate an extension function of the rotator.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * The \a status argument is a value that is not NULL for "activate",
* "deactivate" otherwise, much as TRUE or FALSE boolean definitions in the C
* language.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_get_ext_func() * \sa rot_get_ext_func()
*/ */
@ -569,16 +668,24 @@ int HAMLIB_API rot_set_ext_func(ROT *rot, token_t token, int status)
/** /**
* \brief get the value of a function extra parameter * \brief Query the status of extension functions of a rotator.
* \param rig The rotator handle
* \param token The parameter
* \param status The location where to store the value of \a token
* *
* Retrieves the value of a function extra parameter associated with \a token. * \param rot The #ROT handle.
* \param token The extension function to query the status.
* \param status The variable to store the extension function status.
* *
* \return RIG_OK if the operation has been successful, otherwise * Retrieves the status (On or Off) of an extension function of the rotator.
* a negative value if an error occurred (in which case, cause is * Upon return, \a status will hold the status of the extension function. The
* set appropriately). * value pointed to by the \a status argument is not NULL for "On", or "Off"
* otherwise, much as TRUE or FALSE boolean definitions in the C language.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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
* \a token is not supported.
* *
* \sa rot_set_ext_func() * \sa rot_set_ext_func()
*/ */
@ -605,16 +712,22 @@ int HAMLIB_API rot_get_ext_func(ROT *rot, token_t token, int *status)
/** /**
* \brief set a rotator parm extra parameter * \brief Set a rotator extension parameter to a given value.
* \param rig The rotator handle
* \param token The parameter
* \param val The value to set the parameter to
* *
* Sets an parm extra parameter. * \param rot The #ROT handle.
* \param token The extension parameter token.
* \param val The value of the extension parameter.
* *
* \return RIG_OK if the operation has been successful, otherwise * Set an extension parameter \a token to \a val.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_get_ext_parm() * \sa rot_get_ext_parm()
*/ */
@ -637,16 +750,22 @@ int HAMLIB_API rot_set_ext_parm(ROT *rot, token_t token, value_t val)
/** /**
* \brief get the value of a parm extra parameter * \brief Query the value of a requested rotator extension parameter.
* \param rig The rotator handle
* \param token The parameter
* \param val The location where to store the value of \a token
* *
* Retrieves the value of a parm extra parameter associated with \a token. * \param rot The #ROT handle.
* \param token The extension parameter to query the status.
* \param val The variable to store the extension parameter status.
* *
* \return RIG_OK if the operation has been successful, otherwise * Query the \a val corresponding to the extension parameter \a token.
* a negative value if an error occurred (in which case, cause is *
* set appropriately). * \note \a val can be any type defined by #value_t.
*
* \return RIG_OK if the operation has been successful, otherwise a **negative
* 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.
* *
* \sa rot_set_ext_parm() * \sa rot_set_ext_parm()
*/ */