kopia lustrzana https://github.com/Hamlib/Hamlib
Udate amplifier documentation for consistency
rodzic
9dce43fc50
commit
2556f4fcd1
|
@ -502,8 +502,8 @@ int HAMLIB_API amp_token_foreach(AMP *amp,
|
|||
* to the frontend config params table.
|
||||
*
|
||||
* \return A pointer to the token in the #confparams structure or NULL if
|
||||
* \a amp is invalid or \a token not found (how can the caller know which
|
||||
* occurred?).
|
||||
* \a amp is NULL or inconsistent or if \a token is not found (how can the
|
||||
* caller know which occurred?).
|
||||
*
|
||||
* \sa amp_token_lookup()
|
||||
*
|
||||
|
@ -600,7 +600,7 @@ 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 or \a token was invalid.
|
||||
* \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()
|
||||
|
@ -656,7 +656,7 @@ int HAMLIB_API amp_set_conf(AMP *amp, 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 invalid.
|
||||
* \retval RIG_EINVAL \a amp is NULL or inconsistent.
|
||||
* \retval RIG_ENAVAIL amp_caps#get_conf() capability is not available.
|
||||
*
|
||||
* \sa amp_set_conf()
|
||||
|
|
|
@ -671,7 +671,7 @@ int HAMLIB_API amp_set_freq(AMP *amp, freq_t freq)
|
|||
*
|
||||
* \return A pointer to static memory containing an ASCII nul terminated
|
||||
* string (C string) if the operation has been successful, otherwise NULL if
|
||||
* \a amp is NULL or invalid or the amp_caps#get_info() capability is not
|
||||
* \a amp is NULL or inconsistent or the amp_caps#get_info() capability is not
|
||||
* available.
|
||||
*/
|
||||
const char *HAMLIB_API amp_get_info(AMP *amp)
|
||||
|
|
|
@ -167,7 +167,7 @@ int HAMLIB_API amp_ext_parm_foreach(AMP *amp,
|
|||
* amp_caps::extparms.
|
||||
*
|
||||
* \return A pointer to the containing #confparams structure member or NULL if
|
||||
* nothing found or if \a amp is NULL or invalid.
|
||||
* nothing found or if \a amp is NULL or inconsistent.
|
||||
*
|
||||
* \sa amp_ext_token_lookup()
|
||||
*
|
||||
|
@ -214,7 +214,7 @@ const struct confparams *HAMLIB_API amp_ext_lookup(AMP *amp, const char *name)
|
|||
* Searches the amp_caps::extlevels table first and then falls back to amp_caps::extparms.
|
||||
*
|
||||
* \return A pointer to the containing #confparams structure member or NULL if
|
||||
* nothing found or if \a amp is NULL or invalid.
|
||||
* nothing found or if \a amp is NULL or inconsistent.
|
||||
*/
|
||||
const struct confparams *HAMLIB_API amp_ext_lookup_tok(AMP *amp, token_t token)
|
||||
{
|
||||
|
|
Ładowanie…
Reference in New Issue