kopia lustrzana https://github.com/Hamlib/Hamlib
Fix Doxygen comments
rodzic
8e24746a3e
commit
26d3e79cf5
|
@ -163,7 +163,7 @@ enum rig_errcode_e {
|
||||||
RIG_EDOM, /*!< 17 Argument out of domain of func */
|
RIG_EDOM, /*!< 17 Argument out of domain of func */
|
||||||
RIG_EDEPRECATED,/*!< 18 Function deprecated */
|
RIG_EDEPRECATED,/*!< 18 Function deprecated */
|
||||||
RIG_ESECURITY, /*!< 19 Security error */
|
RIG_ESECURITY, /*!< 19 Security error */
|
||||||
RIG_EPOWER, /*!, 20 Rig not powered on */
|
RIG_EPOWER, /*!< 20 Rig not powered on */
|
||||||
RIG_EEND // MUST BE LAST ITEM IN LAST
|
RIG_EEND // MUST BE LAST ITEM IN LAST
|
||||||
};
|
};
|
||||||
/**
|
/**
|
||||||
|
@ -340,8 +340,8 @@ enum agc_level_e {
|
||||||
RIG_AGC_MEDIUM,
|
RIG_AGC_MEDIUM,
|
||||||
RIG_AGC_AUTO,
|
RIG_AGC_AUTO,
|
||||||
RIG_AGC_LONG,
|
RIG_AGC_LONG,
|
||||||
RIG_AGC_ON, /*< Turns AGC ON -- Kenwood -- restores last level set */
|
RIG_AGC_ON, /*!< Turns AGC ON -- Kenwood -- restores last level set */
|
||||||
RIG_AGC_NONE /*< Rig does not have CAT AGC control */
|
RIG_AGC_NONE /*!< Rig does not have CAT AGC control */
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
@ -2363,7 +2363,7 @@ typedef hamlib_port_t port_t;
|
||||||
#define HAMLIB_ELAPSED_SET 1
|
#define HAMLIB_ELAPSED_SET 1
|
||||||
#define HAMLIB_ELAPSED_INVALIDATE 2
|
#define HAMLIB_ELAPSED_INVALIDATE 2
|
||||||
|
|
||||||
#define HAMLIB_CACHE_ALWAYS (-1) /*< value to set cache timeout to always use cache */
|
#define HAMLIB_CACHE_ALWAYS (-1) /*!< value to set cache timeout to always use cache */
|
||||||
|
|
||||||
typedef enum {
|
typedef enum {
|
||||||
HAMLIB_CACHE_ALL, // to set all cache timeouts at once
|
HAMLIB_CACHE_ALL, // to set all cache timeouts at once
|
||||||
|
@ -2579,16 +2579,16 @@ struct rig_state {
|
||||||
/********* DO NOT ADD or CHANGE anything (or than to rename) ABOVE THIS LINE *********/
|
/********* DO NOT ADD or CHANGE anything (or than to rename) ABOVE THIS LINE *********/
|
||||||
/********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/
|
/********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/
|
||||||
/* flags instructing the rig_get routines to use cached values when asyncio is in use */
|
/* flags instructing the rig_get routines to use cached values when asyncio is in use */
|
||||||
int use_cached_freq; /*<! flag instructing rig_get_freq to use cached values when asyncio is in use */
|
int use_cached_freq; /*!< flag instructing rig_get_freq to use cached values when asyncio is in use */
|
||||||
int use_cached_mode; /*<! flag instructing rig_get_mode to use cached values when asyncio is in use */
|
int use_cached_mode; /*!< flag instructing rig_get_mode to use cached values when asyncio is in use */
|
||||||
int use_cached_ptt; /*<! flag instructing rig_get_ptt to use cached values when asyncio is in use */
|
int use_cached_ptt; /*!< flag instructing rig_get_ptt to use cached values when asyncio is in use */
|
||||||
int depth; /*<! a depth counter to use for debug indentation and such */
|
int depth; /*!< a depth counter to use for debug indentation and such */
|
||||||
int lock_mode; /*<! flag that prevents mode changes if ~= 0 -- see set/get_lock_mode */
|
int lock_mode; /*!< flag that prevents mode changes if ~= 0 -- see set/get_lock_mode */
|
||||||
powerstat_t powerstat; /*<! power status */
|
powerstat_t powerstat; /*!< power status */
|
||||||
char *tuner_control_pathname; /*<! Path to external tuner control program that get 0/1 (Off/On) argument */
|
char *tuner_control_pathname; /*!< Path to external tuner control program that get 0/1 (Off/On) argument */
|
||||||
char client_version[32]; /*<! Allow client to report version for compatility checks/capability */
|
char client_version[32]; /*!<! Allow client to report version for compatility checks/capability */
|
||||||
freq_t offset_vfoa; /*<! Offset to apply to VFOA/Main set_freq */
|
freq_t offset_vfoa; /*!< Offset to apply to VFOA/Main set_freq */
|
||||||
freq_t offset_vfob; /*<! Offset to apply to VFOB/Sub set_freq */
|
freq_t offset_vfob; /*!< Offset to apply to VFOB/Sub set_freq */
|
||||||
};
|
};
|
||||||
|
|
||||||
//! @cond Doxygen_Suppress
|
//! @cond Doxygen_Suppress
|
||||||
|
|
|
@ -1334,7 +1334,7 @@ static const struct
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Convert enum RIG_AGC_... to alpha string
|
* \brief Convert enum RIG_AGC_... to alpha string
|
||||||
* \param mode RIG_AGC_...
|
* \param level RIG_AGC_...
|
||||||
* \return alpha string
|
* \return alpha string
|
||||||
*/
|
*/
|
||||||
const char *HAMLIB_API rig_stragclevel(enum agc_level_e level)
|
const char *HAMLIB_API rig_stragclevel(enum agc_level_e level)
|
||||||
|
|
10
src/rig.c
10
src/rig.c
|
@ -1645,13 +1645,11 @@ int HAMLIB_API rig_set_twiddle(RIG *rig, int seconds)
|
||||||
/**
|
/**
|
||||||
* \brief For GPredict to avoid reading frequency on uplink VFO
|
* \brief For GPredict to avoid reading frequency on uplink VFO
|
||||||
* \param rig The rig handle
|
* \param rig The rig handle
|
||||||
* \param seconds 1=Ignore Sub, 2=Ignore Main
|
* \param val 1=Ignore Sub, 2=Ignore Main
|
||||||
*
|
*
|
||||||
* \return RIG_OK if the operation has been successful, otherwise
|
* \return RIG_OK if the operation has been successful, otherwise
|
||||||
* a negative value if an error occurred (in which case, cause is
|
* a negative value if an error occurred (in which case, cause is
|
||||||
* set appropriately).
|
* set appropriately).
|
||||||
*
|
|
||||||
* \sa rig_set_uplink()
|
|
||||||
*/
|
*/
|
||||||
int HAMLIB_API rig_set_uplink(RIG *rig, int val)
|
int HAMLIB_API rig_set_uplink(RIG *rig, int val)
|
||||||
{
|
{
|
||||||
|
@ -7066,7 +7064,7 @@ static unsigned long gen_crc(unsigned char *p, size_t n)
|
||||||
* \brief get freq/mode/width for requested VFO
|
* \brief get freq/mode/width for requested VFO
|
||||||
* \param rig The rig handle
|
* \param rig The rig handle
|
||||||
*
|
*
|
||||||
* returns a string for all known VFOs plus rig split status and satellite mode status
|
* \returns a string for all known VFOs plus rig split status and satellite mode status
|
||||||
*/
|
*/
|
||||||
int HAMLIB_API rig_get_rig_info(RIG *rig, char *response, int max_response_len)
|
int HAMLIB_API rig_get_rig_info(RIG *rig, char *response, int max_response_len)
|
||||||
{
|
{
|
||||||
|
@ -7238,8 +7236,8 @@ int HAMLIB_API rig_get_vfo_info(RIG *rig, vfo_t vfo, freq_t *freq,
|
||||||
/**
|
/**
|
||||||
* \brief get list of available vfos
|
* \brief get list of available vfos
|
||||||
* \param rig The rig handle
|
* \param rig The rig handle
|
||||||
* \param char* char buffer[SPRINTF_MAX_SIZE] to hold result
|
* \param buf char buffer to hold result
|
||||||
* \param len max length of char buffer
|
* \param buflen max length of char buffer
|
||||||
*
|
*
|
||||||
* Retrieves all usable vfo entries for the rig
|
* Retrieves all usable vfo entries for the rig
|
||||||
*
|
*
|
||||||
|
|
Ładowanie…
Reference in New Issue