Skip to content

Commit dda3053

Browse files
committed
Add cross references hash mark for Doxygen
1 parent bd5ed18 commit dda3053

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

include/hamlib/rig.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -744,7 +744,7 @@ typedef enum {
744744
* NOTE: the vfo argument for some vfo operation may be irrelevant,
745745
* and thus will be ignored.
746746
*
747-
* The VFO/MEM "mode" is set by rig_set_vfo.\n
747+
* The VFO/MEM "mode" is set by #rig_set_vfo.\n
748748
* \c STRING used in rigctl
749749
*
750750
* \sa rig_parse_vfo_op(), rig_strvfop()
@@ -1065,10 +1065,10 @@ typedef uint64_t rig_level_e;
10651065
#define RIG_LEVEL_KEYSPD CONSTANT_64BIT_FLAG(14) /*!< \c KEYSPD -- Key Speed, arg int (WPM) */
10661066
#define RIG_LEVEL_NOTCHF CONSTANT_64BIT_FLAG(15) /*!< \c NOTCHF -- Notch Freq., arg int (Hz) */
10671067
#define RIG_LEVEL_COMP CONSTANT_64BIT_FLAG(16) /*!< \c COMP -- Compressor, arg float [0.0 ... 1.0] */
1068-
#define RIG_LEVEL_AGC CONSTANT_64BIT_FLAG(17) /*!< \c AGC -- AGC, arg int (see enum agc_level_e) */
1068+
#define RIG_LEVEL_AGC CONSTANT_64BIT_FLAG(17) /*!< \c AGC -- AGC, arg int (see enum #agc_level_e) */
10691069
#define RIG_LEVEL_BKINDL CONSTANT_64BIT_FLAG(18) /*!< \c BKINDL -- BKin Delay, arg int (tenth of dots) */
10701070
#define RIG_LEVEL_BALANCE CONSTANT_64BIT_FLAG(19) /*!< \c BAL -- Balance (Dual Watch) arg float [0.0 ... 1.0] */
1071-
#define RIG_LEVEL_METER CONSTANT_64BIT_FLAG(20) /*!< \c METER -- Display meter, arg int (see enum meter_level_e) */
1071+
#define RIG_LEVEL_METER CONSTANT_64BIT_FLAG(20) /*!< \c METER -- Display meter, arg int (see enum #meter_level_e) */
10721072
#define RIG_LEVEL_VOXGAIN CONSTANT_64BIT_FLAG(21) /*!< \c VOXGAIN -- VOX gain level, arg float [0.0 ... 1.0] */
10731073
#define RIG_LEVEL_ANTIVOX CONSTANT_64BIT_FLAG(22) /*!< \c ANTIVOX -- anti-VOX level, arg float [0.0 ... 1.0] */
10741074
#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;
10911091
#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] */
10921092
#define RIG_LEVEL_NB CONSTANT_64BIT_FLAG(38) /*!< \c NB -- Noise Blanker level, arg float [0.0 ... 1.0] */
10931093
#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) */
1094-
#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. */
1094+
#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. */
10951095
#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. */
10961096
#define RIG_LEVEL_SPECTRUM_EDGE_LOW CONSTANT_64BIT_FLAG(42) /*!< \c SPECTRUM_EDGE_LOW -- Spectrum scope low edge in fixed mode, arg int (Hz) */
10971097
#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;
11361136
*/
11371137
enum rig_parm_e {
11381138
RIG_PARM_NONE = 0, /*!< '' -- No Parm */
1139-
RIG_PARM_ANN = (1 << 0), /*!< \c ANN -- "Announce" level, see ann_t */
1139+
RIG_PARM_ANN = (1 << 0), /*!< \c ANN -- "Announce" level, see #ann_t */
11401140
RIG_PARM_APO = (1 << 1), /*!< \c APO -- Auto power off, int in minute */
11411141
RIG_PARM_BACKLIGHT = (1 << 2), /*!< \c BACKLIGHT -- LCD light, float [0.0 ... 1.0] */
11421142
RIG_PARM_BEEP = (1 << 4), /*!< \c BEEP -- Beep on keypressed, int (0,1) */
@@ -1696,7 +1696,7 @@ typedef enum {
16961696
struct chan_list {
16971697
int startc; /*!< Starting memory channel \b number */
16981698
int endc; /*!< Ending memory channel \b number */
1699-
chan_type_t type; /*!< Memory type. see chan_type_t */
1699+
chan_type_t type; /*!< Memory type. See #chan_type_t */
17001700
channel_cap_t mem_caps; /*!< Definition of attributes that can be stored/retrieved */
17011701
};
17021702

src/extamp.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ const struct confparams *HAMLIB_API amp_ext_lookup_tok(AMP *amp,
259259
* \note As this function calls amp_ext_lookup(), it can be considered a
260260
* higher level API.
261261
*
262-
* \return The token ID or RIG_CONF_END if there is a lookup failure.
262+
* \return The token ID or #RIG_CONF_END if there is a lookup failure.
263263
*
264264
* \sa amp_ext_lookup()
265265
*/

src/rig.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6893,8 +6893,8 @@ int HAMLIB_API rig_set_powerstat(RIG *rig, powerstat_t status)
68936893
* \param rig The rig handle
68946894
* \param status The location where to store the current status
68956895
*
6896-
* Retrieve the status of the radio. See RIG_POWER_ON, RIG_POWER_OFF and
6897-
* RIG_POWER_STANDBY defines for the \a status.
6896+
* Retrieve the status of the radio. See #RIG_POWER_ON, #RIG_POWER_OFF and
6897+
* #RIG_POWER_STANDBY defines for the \a status.
68986898
*
68996899
* \return RIG_OK if the operation has been successful, otherwise
69006900
* a negative value if an error occurred (in which case, cause is

src/rot_ext.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@ const struct confparams *HAMLIB_API rot_ext_lookup_tok(ROT *rot,
362362
* \note As this function calls rot_ext_lookup(), it can be considered a
363363
* higher level API.
364364
*
365-
* \return The token ID or RIG_CONF_END if there is a lookup failure.
365+
* \return The token ID or #RIG_CONF_END if there is a lookup failure.
366366
*
367367
* \sa rot_ext_lookup()
368368
*/

0 commit comments

Comments
 (0)