diff --git a/include/hamlib/rig.h b/include/hamlib/rig.h index 1e3486ef1..a6bc0a7e6 100644 --- a/include/hamlib/rig.h +++ b/include/hamlib/rig.h @@ -744,7 +744,7 @@ typedef enum { * NOTE: the vfo argument for some vfo operation may be irrelevant, * and thus will be ignored. * - * The VFO/MEM "mode" is set by rig_set_vfo.\n + * The VFO/MEM "mode" is set by #rig_set_vfo.\n * \c STRING used in rigctl * * \sa rig_parse_vfo_op(), rig_strvfop() @@ -1065,10 +1065,10 @@ typedef uint64_t rig_level_e; #define RIG_LEVEL_KEYSPD CONSTANT_64BIT_FLAG(14) /*!< \c KEYSPD -- Key Speed, arg int (WPM) */ #define RIG_LEVEL_NOTCHF CONSTANT_64BIT_FLAG(15) /*!< \c NOTCHF -- Notch Freq., arg int (Hz) */ #define RIG_LEVEL_COMP CONSTANT_64BIT_FLAG(16) /*!< \c COMP -- Compressor, arg float [0.0 ... 1.0] */ -#define RIG_LEVEL_AGC CONSTANT_64BIT_FLAG(17) /*!< \c AGC -- AGC, arg int (see enum agc_level_e) */ +#define RIG_LEVEL_AGC CONSTANT_64BIT_FLAG(17) /*!< \c AGC -- AGC, arg int (see enum #agc_level_e) */ #define RIG_LEVEL_BKINDL CONSTANT_64BIT_FLAG(18) /*!< \c BKINDL -- BKin Delay, arg int (tenth of dots) */ #define RIG_LEVEL_BALANCE CONSTANT_64BIT_FLAG(19) /*!< \c BAL -- Balance (Dual Watch) arg float [0.0 ... 1.0] */ -#define RIG_LEVEL_METER CONSTANT_64BIT_FLAG(20) /*!< \c METER -- Display meter, arg int (see enum meter_level_e) */ +#define RIG_LEVEL_METER CONSTANT_64BIT_FLAG(20) /*!< \c METER -- Display meter, arg int (see enum #meter_level_e) */ #define RIG_LEVEL_VOXGAIN CONSTANT_64BIT_FLAG(21) /*!< \c VOXGAIN -- VOX gain level, arg float [0.0 ... 1.0] */ #define RIG_LEVEL_ANTIVOX CONSTANT_64BIT_FLAG(22) /*!< \c ANTIVOX -- anti-VOX level, arg float [0.0 ... 1.0] */ #define RIG_LEVEL_SLOPE_LOW CONSTANT_64BIT_FLAG(23) /*!< \c SLOPE_LOW -- Slope tune, low frequency cut, arg int (Hz) */ @@ -1091,7 +1091,7 @@ typedef uint64_t rig_level_e; #define RIG_LEVEL_MONITOR_GAIN CONSTANT_64BIT_FLAG(37) /*!< \c MONITOR_GAIN -- Monitor gain (level for monitoring of transmitted audio) arg float [0.0 ... 1.0] */ #define RIG_LEVEL_NB CONSTANT_64BIT_FLAG(38) /*!< \c NB -- Noise Blanker level, arg float [0.0 ... 1.0] */ #define RIG_LEVEL_RFPOWER_METER_WATTS CONSTANT_64BIT_FLAG(39) /*!< \c RFPOWER_METER_WATTS -- RF power output meter, arg float [0.0 ... MAX] (output power in watts) */ -#define RIG_LEVEL_SPECTRUM_MODE CONSTANT_64BIT_FLAG(40) /*!< \c SPECTRUM_MODE -- Spectrum scope mode, arg int (see enum rig_spectrum_mode_e). Supported modes defined in rig caps. */ +#define RIG_LEVEL_SPECTRUM_MODE CONSTANT_64BIT_FLAG(40) /*!< \c SPECTRUM_MODE -- Spectrum scope mode, arg int (see enum #rig_spectrum_mode_e). Supported modes defined in rig caps. */ #define RIG_LEVEL_SPECTRUM_SPAN CONSTANT_64BIT_FLAG(41) /*!< \c SPECTRUM_SPAN -- Spectrum scope span in center mode, arg int (Hz). Supported spans defined in rig caps. */ #define RIG_LEVEL_SPECTRUM_EDGE_LOW CONSTANT_64BIT_FLAG(42) /*!< \c SPECTRUM_EDGE_LOW -- Spectrum scope low edge in fixed mode, arg int (Hz) */ #define RIG_LEVEL_SPECTRUM_EDGE_HIGH CONSTANT_64BIT_FLAG(43) /*!< \c SPECTRUM_EDGE_HIGH -- Spectrum scope high edge in fixed mode, arg int (Hz) */ @@ -1136,7 +1136,7 @@ typedef uint64_t rig_level_e; */ enum rig_parm_e { RIG_PARM_NONE = 0, /*!< '' -- No Parm */ - RIG_PARM_ANN = (1 << 0), /*!< \c ANN -- "Announce" level, see ann_t */ + RIG_PARM_ANN = (1 << 0), /*!< \c ANN -- "Announce" level, see #ann_t */ RIG_PARM_APO = (1 << 1), /*!< \c APO -- Auto power off, int in minute */ RIG_PARM_BACKLIGHT = (1 << 2), /*!< \c BACKLIGHT -- LCD light, float [0.0 ... 1.0] */ RIG_PARM_BEEP = (1 << 4), /*!< \c BEEP -- Beep on keypressed, int (0,1) */ @@ -1696,7 +1696,7 @@ typedef enum { struct chan_list { int startc; /*!< Starting memory channel \b number */ int endc; /*!< Ending memory channel \b number */ - chan_type_t type; /*!< Memory type. see chan_type_t */ + chan_type_t type; /*!< Memory type. See #chan_type_t */ channel_cap_t mem_caps; /*!< Definition of attributes that can be stored/retrieved */ }; diff --git a/src/extamp.c b/src/extamp.c index 19552b651..278e308bf 100644 --- a/src/extamp.c +++ b/src/extamp.c @@ -259,7 +259,7 @@ const struct confparams *HAMLIB_API amp_ext_lookup_tok(AMP *amp, * \note As this function calls amp_ext_lookup(), it can be considered a * higher level API. * - * \return The token ID or RIG_CONF_END if there is a lookup failure. + * \return The token ID or #RIG_CONF_END if there is a lookup failure. * * \sa amp_ext_lookup() */ diff --git a/src/rig.c b/src/rig.c index cecfa78d0..e568402f8 100644 --- a/src/rig.c +++ b/src/rig.c @@ -6893,8 +6893,8 @@ int HAMLIB_API rig_set_powerstat(RIG *rig, powerstat_t status) * \param rig The rig handle * \param status The location where to store the current status * - * Retrieve the status of the radio. See RIG_POWER_ON, RIG_POWER_OFF and - * RIG_POWER_STANDBY defines for the \a status. + * Retrieve the status of the radio. See #RIG_POWER_ON, #RIG_POWER_OFF and + * #RIG_POWER_STANDBY defines for the \a status. * * \return RIG_OK if the operation has been successful, otherwise * a negative value if an error occurred (in which case, cause is diff --git a/src/rot_ext.c b/src/rot_ext.c index 0d7c34a32..63915b7ed 100644 --- a/src/rot_ext.c +++ b/src/rot_ext.c @@ -362,7 +362,7 @@ const struct confparams *HAMLIB_API rot_ext_lookup_tok(ROT *rot, * \note As this function calls rot_ext_lookup(), it can be considered a * higher level API. * - * \return The token ID or RIG_CONF_END if there is a lookup failure. + * \return The token ID or #RIG_CONF_END if there is a lookup failure. * * \sa rot_ext_lookup() */