[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. 355d237ffe97437109186
Library to control radio transceivers and receivers
Brought to you by:
n0nb
From: n0nb <n0...@us...> - 2025-06-07 02:23:03
|
This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Hamlib -- Ham radio control libraries". The branch, master has been updated via 355d237ffe974371091865fe73bd1bce42a4c085 (commit) via ea5a5ac312393189c8e46b5315b8a450df7e6a93 (commit) from 778edf7757966c6e8df1089c8536f81fad64288b (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 355d237ffe974371091865fe73bd1bce42a4c085 Merge: 778edf775 ea5a5ac31 Author: Nate Bargmann <n0...@n0...> Date: Fri Jun 6 21:18:35 2025 -0500 Merge GitHub PR #1758 commit ea5a5ac312393189c8e46b5315b8a450df7e6a93 Author: Daniele Forsi IU5HKX <iu...@gm...> Date: Mon May 26 22:59:36 2025 +0200 Fix Doxygen tags diff --git a/rigs/aor/ar7030p.c b/rigs/aor/ar7030p.c index 2d57b0f17..7ed486006 100644 --- a/rigs/aor/ar7030p.c +++ b/rigs/aor/ar7030p.c @@ -352,12 +352,12 @@ static int ar7030p_cleanup(RIG *rig) return (rc); } -/* - * /brief Open I/O to receiver +/** + * \brief Open I/O to receiver * - * /param rig Pointer to rig struct + * \param rig Pointer to rig struct * - * /return 0 on success, < 0 on failure + * \return 0 on success, < 0 on failure */ static int ar7030p_open(RIG *rig) { @@ -422,12 +422,12 @@ static int ar7030p_open(RIG *rig) return (rc); } -/* - * /brief Close I/O to receiver +/** + * \brief Close I/O to receiver * - * /param rig Pointer to rig struct + * \param rig Pointer to rig struct * - * /return 0 on success, < 0 on failure + * \return 0 on success, < 0 on failure */ // cppcheck-suppress * static int ar7030p_close(RIG *rig) @@ -468,11 +468,11 @@ static const char *ar7030p_get_info(RIG *rig) } /* - * /brief Set receiver frequency + * \brief Set receiver frequency * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param freq Frequency to set + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param freq Frequency to set * */ static int ar7030p_set_freq(RIG *rig, vfo_t vfo, freq_t freq) @@ -528,11 +528,11 @@ static int ar7030p_set_freq(RIG *rig, vfo_t vfo, freq_t freq) } /* - * /brief Get receiver frequency + * \brief Get receiver frequency * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param freq Pointer to hold frequency value (in Hz) + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param freq Pointer to hold frequency value (in Hz) * */ static int ar7030p_get_freq(RIG *rig, vfo_t vfo, freq_t *freq) @@ -584,12 +584,12 @@ static int ar7030p_get_freq(RIG *rig, vfo_t vfo, freq_t *freq) } /* - * /brief Set receiver mode + * \brief Set receiver mode * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param mode Mode to set - * /param width Bandwidth to set + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param mode Mode to set + * \param width Bandwidth to set * */ static int ar7030p_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, @@ -650,12 +650,12 @@ static int ar7030p_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, } /* - * /brief Get receiver mode and bandwidth + * \brief Get receiver mode and bandwidth * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param mode Pointer to value to hold mode - * /param width Pointer to value to hold bandwidth + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param mode Pointer to value to hold mode + * \param width Pointer to value to hold bandwidth * */ static int ar7030p_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, @@ -694,16 +694,16 @@ static int ar7030p_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, } /* - * /brief Get memory channel parameters + * \brief Get memory channel parameters * - * /param rig Pointer to rig struct - * /param chan Channel number (0-399) - * /param freq Pointer to frequency value - * /param mode Pointer to mode value (1-7) - * /param filt Pointer to filter value (1-6) - * /param pbs Pointer to passband tuning value - * /param sql Pointer to squelch value (0-255) - * /param id Pointer to channel ident string (14 chars) + * \param rig Pointer to rig struct + * \param chan Channel number (0-399) + * \param freq Pointer to frequency value + * \param mode Pointer to mode value (1-7) + * \param filt Pointer to filter value (1-6) + * \param pbs Pointer to passband tuning value + * \param sql Pointer to squelch value (0-255) + * \param id Pointer to channel ident string (14 chars) * */ #if 0 /* unused; re-enabled as needed. */ @@ -818,14 +818,14 @@ static void ar7030p_get_memory(RIG *rig, const unsigned int chan, #endif /* unused */ /* - * /brief Set receiver levels + * \brief Set receiver levels * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param level Level to set - * /param val Value to set level to + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param level Level to set + * \param val Value to set level to * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_set_level(RIG *rig, vfo_t vfo, setting_t level, value_t val) @@ -996,14 +996,14 @@ static int ar7030p_set_level(RIG *rig, vfo_t vfo, setting_t level, /* - * /brief Get receiver levels + * \brief Get receiver levels * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param level Level to get - * /param val Pointer to value to get + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param level Level to get + * \param val Pointer to value to get * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_get_level(RIG *rig, vfo_t vfo, setting_t level, value_t *val) @@ -1469,13 +1469,13 @@ static int ar7030p_set_ts(RIG *rig, vfo_t vfo, shortfreq_t ts) } /* - * /brief Get receiver tuning step size + * \brief Get receiver tuning step size * - * /param rig Pointer to rig struct - * /param vfo VFO to operate on - * /param ts Pointer to tuning step value + * \param rig Pointer to rig struct + * \param vfo VFO to operate on + * \param ts Pointer to tuning step value * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts) { @@ -1506,12 +1506,12 @@ static int ar7030p_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts) } /* - * /brief Set receiver power status + * \brief Set receiver power status * - * /param rig Pointer to rig struct - * /param status Power status to set + * \param rig Pointer to rig struct + * \param status Power status to set * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_set_powerstat(RIG *rig, powerstat_t status) { @@ -1542,12 +1542,12 @@ static int ar7030p_set_powerstat(RIG *rig, powerstat_t status) } /* - * /brief Get receiver power status + * \brief Get receiver power status * - * /param rig Pointer to rig struct - * /param status Pointer to power status value + * \param rig Pointer to rig struct + * \param status Pointer to power status value * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_get_powerstat(RIG *rig, powerstat_t *status) { @@ -1581,12 +1581,12 @@ static int ar7030p_get_powerstat(RIG *rig, powerstat_t *status) } /* - * /brief Reset receiver + * \brief Reset receiver * - * /param rig Pointer to rig struct - * /param reset Reset operation to perform + * \param rig Pointer to rig struct + * \param reset Reset operation to perform * - * /return RIG_OK on success + * \return RIG_OK on success */ static int ar7030p_reset(RIG *rig, reset_t reset) { diff --git a/rigs/aor/ar7030p_utils.c b/rigs/aor/ar7030p_utils.c index adeef7b8b..b59a8af44 100644 --- a/rigs/aor/ar7030p_utils.c +++ b/rigs/aor/ar7030p_utils.c @@ -387,11 +387,11 @@ int BUT(RIG *rig, enum BUTTON_e button) #endif // 0 -/* - * /brief Execute routine +/** + * \brief Execute routine * - * /param rig Pointer to rig struct - * /param rtn Receiver routine to execute + * \param rig Pointer to rig struct + * \param rtn Receiver routine to execute * * \return RIG_OK on success, error code on failure * @@ -413,12 +413,12 @@ int execRoutine(RIG *rig, enum ROUTINE_e rtn) return (rc); } -/* - * /brief Set address for I/O with radio +/** + * \brief Set address for I/O with radio * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) * * \return RIG_OK on success, error code on failure * @@ -513,12 +513,12 @@ static int setAddr(RIG *rig, enum PAGE_e page, unsigned int addr) } /* - * /brief Write one byte to the receiver + * \brief Write one byte to the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Value to write to radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Value to write to radio * * \return RIG_OK on success, error code on failure * @@ -554,12 +554,12 @@ int writeByte(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned char x) } /* - * /brief Write two bytes to the receiver + * \brief Write two bytes to the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Value to write to radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Value to write to radio * * \return Number of bytes written, 0 on error. Get error code with getErrno. * @@ -581,12 +581,12 @@ int writeShort(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned short x) } /* - * /brief Write three bytes to the receiver + * \brief Write three bytes to the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Value to write to radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Value to write to radio * * \return Number of bytes written, 0 on error. Get error code with getErrno. * @@ -616,12 +616,12 @@ int write3Bytes(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned int x) #ifdef XXREMOVEDXX // this function is not referenced anywhere /* - * /brief Write unsigned int (4 bytes) to the receiver + * \brief Write unsigned int (4 bytes) to the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Value to write to radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Value to write to radio * * \return Number of bytes written, 0 on error. Get error code with getErrno. * @@ -656,12 +656,12 @@ int writeInt(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned int x) #endif /* - * /brief Read one byte from the receiver + * \brief Read one byte from the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Pointer to value to read from radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Pointer to value to read from radio * * \return RIG_OK on success, error code on failure * @@ -697,12 +697,12 @@ int readByte(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned char *x) } /* - * /brief Read an unsigned short (two bytes) from the receiver + * \brief Read an unsigned short (two bytes) from the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Pointer to value to read from radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Pointer to value to read from radio * * \return RIG_OK on success, error code on failure * @@ -734,12 +734,12 @@ int readShort(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned short *x) } /* - * /brief Read an unsigned int (three bytes) from the receiver + * \brief Read an unsigned int (three bytes) from the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Pointer to value to read from radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Pointer to value to read from radio * * \return RIG_OK on success, error code on failure * @@ -779,12 +779,12 @@ int read3Bytes(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned int *x) #ifdef XXREMOVEDXX // this function is not referenced anywhere /* - * /brief Read an unsigned int (four bytes) from the receiver + * \brief Read an unsigned int (four bytes) from the receiver * - * /param rig Pointer to rig struct - * /param page Memory page number (0-4, 15) - * /param addr Address offset within page (0-4095, depending on page) - * /param x Pointer to value to read from radio + * \param rig Pointer to rig struct + * \param page Memory page number (0-4, 15) + * \param addr Address offset within page (0-4095, depending on page) + * \param x Pointer to value to read from radio * * \return RIG_OK on success, error code on failure * @@ -827,9 +827,9 @@ int readInt(RIG *rig, enum PAGE_e page, unsigned int addr, unsigned int *x) #endif /* - * /brief Read raw AGC value from the radio + * \brief Read raw AGC value from the radio * - * /param rig Pointer to rig struct + * \param rig Pointer to rig struct * * \return RIG_OK on success, error code on failure */ @@ -858,9 +858,9 @@ int readSignal(RIG *rig, unsigned char *x) #ifdef XXREMOVEDXX // this function is not referenced anywhere /* - * /brief Flush I/O with radio + * \brief Flush I/O with radio * - * /param rig Pointer to rig struct + * \param rig Pointer to rig struct * */ int flushBuffer(RIG *rig) @@ -880,10 +880,10 @@ int flushBuffer(RIG *rig) #endif /* - * /brief Lock receiver for remote operations + * \brief Lock receiver for remote operations * - * /param rig Pointer to rig struct - * /param level Lock level (0-3) + * \param rig Pointer to rig struct + * \param level Lock level (0-3) * */ int lockRx(RIG *rig, enum LOCK_LVL_e level) @@ -1104,11 +1104,11 @@ int getFilterBW(RIG *rig, enum FILTER_e filter) } /* - * /brief Convert DDS steps to frequency in Hz + * \brief Convert DDS steps to frequency in Hz * - * /param steps DDS count + * \param steps DDS count * - * /return Frequency in Hz or 0 on failure + * \return Frequency in Hz or 0 on failure */ freq_t ddsToHz(const unsigned int steps) { @@ -1120,11 +1120,11 @@ freq_t ddsToHz(const unsigned int steps) } /* - * /brief Convert frequency in Hz to DDS steps + * \brief Convert frequency in Hz to DDS steps * - * /param freq Frequency in Hz + * \param freq Frequency in Hz * - * /return DDS steps (24 bits) or 0 on failure + * \return DDS steps (24 bits) or 0 on failure */ unsigned int hzToDDS(const freq_t freq) { @@ -1156,11 +1156,11 @@ unsigned int hzToDDS(const freq_t freq) } /* - * /brief Convert PBS/BFO steps to frequency in Hz + * \brief Convert PBS/BFO steps to frequency in Hz * - * /param steps PBS/BFO offset steps + * \param steps PBS/BFO offset steps * - * /return Frequency in Hz or 0 on failure + * \return Frequency in Hz or 0 on failure * * Max +ve offset is 127, max -ve offset is 128 * Min -ve offset is 255 @@ -1187,11 +1187,11 @@ float pbsToHz(const unsigned char steps) #ifdef XXREMOVEDXX // this function is not referenced anywhere /* - * /brief Convert PBS/BFO offset frequency in Hz to steps + * \brief Convert PBS/BFO offset frequency in Hz to steps * - * /param freq Offset frequency in Hz + * \param freq Offset frequency in Hz * - * /return steps (8 bits) or 0 on failure + * \return steps (8 bits) or 0 on failure */ unsigned char hzToPBS(const float freq) { @@ -1229,11 +1229,11 @@ unsigned char hzToPBS(const float freq) #endif /* - * /brief Convert native Mode to Hamlib mode + * \brief Convert native Mode to Hamlib mode * - * /param mode Native mode value + * \param mode Native mode value * - * /return Hamlib mode value + * \return Hamlib mode value */ rmode_t modeToHamlib(const unsigned char mode) { @@ -1280,11 +1280,11 @@ rmode_t modeToHamlib(const unsigned char mode) } /* - * /brief Convert Hamlib Mode to native mode + * \brief Convert Hamlib Mode to native mode * - * /param mode Hamlib mode value + * \param mode Hamlib mode value * - * /return Native mode value + * \return Native mode value */ unsigned char modeToNative(const rmode_t mode) { @@ -1331,11 +1331,11 @@ unsigned char modeToNative(const rmode_t mode) } /* - * /brief Convert native AGC speed to Hamlib AGC speed + * \brief Convert native AGC speed to Hamlib AGC speed * - * /param agc Native AGC speed value + * \param agc Native AGC speed value * - * /return Hamlib AGC speed value + * \return Hamlib AGC speed value */ enum agc_level_e agcToHamlib(const unsigned char agc) { @@ -1370,11 +1370,11 @@ enum agc_level_e agcToHamlib(const unsigned char agc) } /* - * /brief Convert Hamlib AGC speed to native AGC speed + * \brief Convert Hamlib AGC speed to native AGC speed * - * /param agc Hamlib AGC speed value + * \param agc Hamlib AGC speed value * - * /return Native AGC speed value + * \return Native AGC speed value */ unsigned char agcToNative(const enum agc_level_e agc) { @@ -1413,11 +1413,11 @@ unsigned char agcToNative(const enum agc_level_e agc) } /* - * /brief Get page size + * \brief Get page size * - * /param page Page to get size of + * \param page Page to get size of * - * /return Page size, -1 on error + * \return Page size, -1 on error */ int pageSize(const enum PAGE_e page) { @@ -1440,9 +1440,9 @@ int pageSize(const enum PAGE_e page) } /* - * /brief Set and execute IR controller code + * \brief Set and execute IR controller code * - * /param code IR code to execute + * \param code IR code to execute * * \return RIG_OK on success, error code on failure */ diff --git a/src/misc.c b/src/misc.c index b65722182..0a59f1499 100644 --- a/src/misc.c +++ b/src/misc.c @@ -1028,7 +1028,7 @@ static const struct { AMP_LEVEL_NONE, "" }, }; -/* +/** * \brief check input to set_level * \param rig Pointer to rig data * \param level RIG_LEVEL_* trying to set diff --git a/src/rig.c b/src/rig.c index 71944b292..5fff46aae 100644 --- a/src/rig.c +++ b/src/rig.c @@ -2976,7 +2976,7 @@ int HAMLIB_API rig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width) RETURNFUNC(retcode); } -/* +/** * \brief get the mode of the target VFO * \param rig The rig handle * \param vfo The target VFO ----------------------------------------------------------------------- Summary of changes: rigs/aor/ar7030p.c | 128 +++++++++++++++++------------------ rigs/aor/ar7030p_utils.c | 170 +++++++++++++++++++++++------------------------ src/misc.c | 2 +- src/rig.c | 2 +- 4 files changed, 151 insertions(+), 151 deletions(-) hooks/post-receive -- Hamlib -- Ham radio control libraries |