From 6de5aa78386a493a64eec12bfcc8814c8e9f8dc7 Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 19 Mar 2023 18:31:02 +0100 Subject: [PATCH 1/5] Fix Doxygen unmatched directives \cond and \endcond --- include/hamlib/rig.h | 5 ----- src/debug.c | 2 -- src/misc.c | 4 ++++ 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/include/hamlib/rig.h b/include/hamlib/rig.h index 361d7d369..618d9e7c5 100644 --- a/include/hamlib/rig.h +++ b/include/hamlib/rig.h @@ -2074,7 +2074,6 @@ struct rig_caps { * \brief Enumeration of all rig_ functions * */ -//! @cond Doxygen_Suppress // all functions enumerated for rig_get_function_ptr enum rig_function_e { RIG_FUNCTION_INIT, @@ -2171,14 +2170,12 @@ enum rig_function_e { * \brief Function to return pointer to rig_* function * */ -//! @cond Doxygen_Suppress extern HAMLIB_EXPORT (void *) rig_get_function_ptr(rig_model_t rig_model, enum rig_function_e rig_function); /** * \brief Enumeration of rig->caps values * */ -//! @cond Doxygen_Suppress // values enumerated for rig->caps values enum rig_caps_int_e { RIG_CAPS_TARGETABLE_VFO, @@ -2199,14 +2196,12 @@ enum rig_caps_cptr_e { * \brief Function to return int value from rig->caps * Does not support > 32-bit rig_caps values */ -//! @cond Doxygen_Suppress extern HAMLIB_EXPORT (long long) rig_get_caps_int(rig_model_t rig_model, enum rig_caps_int_e rig_caps); /** * \brief Function to return char pointer value from rig->caps * */ -//! @cond Doxygen_Suppress extern HAMLIB_EXPORT (const char *) rig_get_caps_cptr(rig_model_t rig_model, enum rig_caps_cptr_e rig_caps); struct hamlib_async_pipe; diff --git a/src/debug.c b/src/debug.c index 6cb338799..fdefd6706 100644 --- a/src/debug.c +++ b/src/debug.c @@ -178,8 +178,6 @@ void HAMLIB_API rig_set_debug_time_stamp(int flag) rig_debug_time_stamp = flag; } -//! @endcond - /** * \brief Print debugging messages through `stderr` by default. diff --git a/src/misc.c b/src/misc.c index 41fe8d7eb..3f7e6aaad 100644 --- a/src/misc.c +++ b/src/misc.c @@ -1828,6 +1828,8 @@ void HAMLIB_API rig_no_restore_ai() no_restore_ai = -1; } +//! @endcond + //! @cond Doxygen_Suppress double HAMLIB_API elapsed_ms(struct timespec *start, int option) @@ -1882,6 +1884,8 @@ double HAMLIB_API elapsed_ms(struct timespec *start, int option) return elapsed_msec; } +//! @endcond + int HAMLIB_API rig_get_cache_timeout_ms(RIG *rig, hamlib_cache_t selection) { From 38cc75c5681b932809634724ef1adfefb467461d Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 19 Mar 2023 18:54:27 +0100 Subject: [PATCH 2/5] Fix Doxygen documentation for the Apex rotator Fixes: .../include/hamlib/rotlist.h:672: warning: documentation for unknown define ROT_MODEL_APEX found. .../include/hamlib/rotlist.h:680: warning: Member ROT_MODEL_APEX_SHARED_LOOP (macro definition) of group rotator is not documented. --- include/hamlib/rotlist.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/hamlib/rotlist.h b/include/hamlib/rotlist.h index d787c29cc..34c76d28e 100644 --- a/include/hamlib/rotlist.h +++ b/include/hamlib/rotlist.h @@ -669,7 +669,7 @@ /** * \brief A macro that returns the model number of the APEX backend. * - * \def ROT_MODEL_APEX + * \def ROT_MODEL_APEX_SHARED_LOOP * * The APEX backend can be used with APEX * rotators. */ From 3c94527fb6a33db6a1f70955bc56e86da6be95d2 Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 19 Mar 2023 19:03:14 +0100 Subject: [PATCH 3/5] Fix Doxygen documentation for the GRBLTRK rotators Fixes: .../include/hamlib/rotlist.h:642: warning: documentation for unknown define ROT_MODEL_GRBLTRK found. .../include/hamlib/rotlist.h:651: warning: Member ROT_MODEL_GRBLTRK_SER (macro definition) of group rotator is not documented. .../include/hamlib/rotlist.h:652: warning: Member ROT_MODEL_GRBLTRK_NET (macro definition) of group rotator is not documented. .../include/hamlib/rotlist.h:651: warning: Member ROT_MODEL_GRBLTRK_SER (macro definition) of group rotator is not documented. .../include/hamlib/rotlist.h:652: warning: Member ROT_MODEL_GRBLTRK_NET (macro definition) of group rotator is not documented. --- include/hamlib/rotlist.h | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/include/hamlib/rotlist.h b/include/hamlib/rotlist.h index 34c76d28e..972df2d00 100644 --- a/include/hamlib/rotlist.h +++ b/include/hamlib/rotlist.h @@ -637,9 +637,17 @@ #define ROT_MODEL_ANDROIDSENSOR ROT_MAKE_MODEL(ROT_ANDROIDSENSOR, 1) /** - * \brief A macro that returns the model number of the GRBLTRK backend. + * \brief A macro that returns the model number of the ROT_MODEL_GRBLTRK_SER backend. * - * \def ROT_MODEL_GRBLTRK + * \def ROT_MODEL_GRBLTRK_SER + * + * The GRBLTRK backend can be used with rotators that support the GRBL + * protocol. + */ +/** + * \brief A macro that returns the model number of the ROT_MODEL_GRBLTRK_NET backend. + * + * \def ROT_MODEL_GRBLTRK_NET * * The GRBLTRK backend can be used with rotators that support the GRBL * protocol. From 8e24746a3e14d0e3ed78e42d37a5132b99573b1e Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 19 Mar 2023 19:17:38 +0100 Subject: [PATCH 4/5] Fix typos --- include/hamlib/rotlist.h | 2 +- rigs/icom/icom.c | 2 +- rigs/kenwood/k3.c | 4 ++-- rigs/tentec/tt550.c | 2 +- rigs/uniden/uniden_digital.c | 2 +- rigs/yaesu/newcat.c | 6 +++--- src/rig.c | 10 +++++----- src/tones.c | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/include/hamlib/rotlist.h b/include/hamlib/rotlist.h index 972df2d00..8be4b09d2 100644 --- a/include/hamlib/rotlist.h +++ b/include/hamlib/rotlist.h @@ -666,7 +666,7 @@ * * The FLIR backend can be used with FLIR and DirectedPercepition * rotators using the PTU protocol (e.g. PTU-D48). Currently only - * the serial interaface is supported and no ethernet. + * the serial interface is supported and no ethernet. */ //! @cond Doxygen_Suppress #define ROT_FLIR 25 diff --git a/rigs/icom/icom.c b/rigs/icom/icom.c index c4d9b9c65..71c401313 100644 --- a/rigs/icom/icom.c +++ b/rigs/icom/icom.c @@ -7790,7 +7790,7 @@ int icom_set_dcs_code(RIG *rig, vfo_t vfo, tone_t code) RETURNFUNC(-RIG_EINVAL); } - /* DCS Polarity ignored, by setting code_len to 3 it's foretval to 0 (= Tx:norm, Rx:norm). */ + /* DCS Polarity ignored, by setting code_len to 3 it's forced to 0 (= Tx:norm, Rx:norm). */ code_len = 3; to_bcd_be(codebuf, code, code_len * 2); diff --git a/rigs/kenwood/k3.c b/rigs/kenwood/k3.c index 499010c03..2cc7c48d6 100644 --- a/rigs/kenwood/k3.c +++ b/rigs/kenwood/k3.c @@ -2762,7 +2762,7 @@ int k4_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt) // The K4 has a problem in Fake It mode where the FA command is ignored -// We will use it's special TQ command to try and ensure PTT is really off +// We will use its special TQ command to try and ensure PTT is really off int k4_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt) { char pttbuf[6]; @@ -2808,7 +2808,7 @@ int k4_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt) return RIG_OK; } -// K3S band memory needs some time to do it's thing after freq change +// K3S band memory needs some time to do its thing after freq change // K3 probably does too // But what about the K4? int k3_set_freq(RIG *rig, vfo_t vfo, freq_t freq) diff --git a/rigs/tentec/tt550.c b/rigs/tentec/tt550.c index f80d25d20..de1690447 100644 --- a/rigs/tentec/tt550.c +++ b/rigs/tentec/tt550.c @@ -460,7 +460,7 @@ tt550_trx_open(RIG *rig) priv = (struct tt550_priv_data *) rig->state.priv; /* - * Reset the radio and start it's program running + * Reset the radio and start its program running * We'll try twice to reset before giving up */ if (tt550_reset(rig, RIG_RESET_SOFT) != RIG_OK) diff --git a/rigs/uniden/uniden_digital.c b/rigs/uniden/uniden_digital.c index a48db0537..d72d02936 100644 --- a/rigs/uniden/uniden_digital.c +++ b/rigs/uniden/uniden_digital.c @@ -293,7 +293,7 @@ const char *uniden_digital_get_info(RIG *rig) * STS command returns 3 lines including system, truck, freq info * * XXX indicates the BCD996T returns some non-printable ascii chars - * within it's comma separated fields. See pg 30-32 of BCD996T_Protocol.pdf. + * within its comma separated fields. See pg 30-32 of BCD996T_Protocol.pdf. * These chars cause abnomalies on stdout! */ /* FIXME: Strip or replace non-printable chars return from STS command! diff --git a/rigs/yaesu/newcat.c b/rigs/yaesu/newcat.c index 18ed14fa5..939b05e04 100644 --- a/rigs/yaesu/newcat.c +++ b/rigs/yaesu/newcat.c @@ -1169,7 +1169,7 @@ int newcat_set_freq(RIG *rig, vfo_t vfo, freq_t freq) __func__, rigerror(err)); } - hl_usleep(500 * 1000); // wait for BS to do it's thing and swap back + hl_usleep(500 * 1000); // wait for BS to do its thing and swap back if (newcat_valid_command(rig, "VS")) { @@ -1193,7 +1193,7 @@ int newcat_set_freq(RIG *rig, vfo_t vfo, freq_t freq) __func__, rigerror(err)); } - hl_usleep(500 * 1000); // wait for BS to do it's thing + hl_usleep(500 * 1000); // wait for BS to do its thing } @@ -10964,7 +10964,7 @@ int newcat_set_cmd(RIG *rig) if (strncmp(priv->cmd_str, "BS", 2) == 0) { - // the BS command needs time to do it's thing + // the BS command needs time to do its thing hl_usleep(500 * 1000); priv->cache_start.tv_sec = 0; // invalidate the cache } diff --git a/src/rig.c b/src/rig.c index 0211d1f7e..19d28b087 100644 --- a/src/rig.c +++ b/src/rig.c @@ -480,7 +480,7 @@ static int rig_check_rig_caps() } /** - * \brief allocate a new RIG handle + * \brief Allocate a new #RIG handle. * \param rig_model The rig model for this new handle * * Allocates a new RIG handle and initializes the associated data @@ -3070,7 +3070,7 @@ int HAMLIB_API rig_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt) } #if 0 - hl_usleep(50 * 1000); // give PTT a chance to do it's thing + hl_usleep(50 * 1000); // give PTT a chance to do its thing // don't use the cached value and check to see if it worked elapsed_ms(&rig->state.cache.time_ptt, HAMLIB_ELAPSED_INVALIDATE); @@ -4948,7 +4948,7 @@ int HAMLIB_API rig_get_split_freq_mode(RIG *rig, /** * \brief set the split mode * \param rig The rig handle - * \param vfo The target VFO + * \param rx_vfo The receive VFO * \param split The split mode to set to * \param tx_vfo The transmit VFO * @@ -6015,7 +6015,7 @@ int HAMLIB_API rig_mW2power(RIG *rig, * * Returns the best frequency resolution of the rig, for a given \a mode. * - * \return the frequency resolution in Hertz if the operation h + * \return the frequency resolution in Hertz if the operation * has been successful, otherwise a negative value if an error occurred. * */ @@ -6054,7 +6054,7 @@ shortfreq_t HAMLIB_API rig_get_resolution(RIG *rig, rmode_t mode) * 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, ortherwise + * \return RIG_OK if the operation has been successful, otherwise * a negative value if an error occurred (in which case, cause is * set appropriately). * diff --git a/src/tones.c b/src/tones.c index c77704b79..768e377f3 100644 --- a/src/tones.c +++ b/src/tones.c @@ -480,7 +480,7 @@ int HAMLIB_API rig_get_ctcss_sql(RIG *rig, vfo_t vfo, tone_t *tone) * * Sets the current Digitally-Coded *Squelch* code. * - * \return returns RIG_OK if the operation has been successful, ortherwise + * \return RIG_OK if the operation has been successful, otherwise * a negative value if an error occurred (in which case, cause is set * appropriately). * @@ -542,7 +542,7 @@ int HAMLIB_API rig_set_dcs_sql(RIG *rig, vfo_t vfo, tone_t code) * * Retrieves the current Digitally-Coded *Squelch* code. * - * \return RIG_OK if the operation has been successful, ortherwise + * \return RIG_OK if the operation has been successful, otherwise * a negative value if an error occurred (in which case, cause is * set appropriately). * From 26d3e79cf5dc3fbca64a6fd6c68ed58fdcfbaa3c Mon Sep 17 00:00:00 2001 From: Daniele Forsi IU5HKX Date: Sun, 19 Mar 2023 21:23:35 +0100 Subject: [PATCH 5/5] Fix Doxygen comments --- include/hamlib/rig.h | 28 ++++++++++++++-------------- src/misc.c | 2 +- src/rig.c | 10 ++++------ 3 files changed, 19 insertions(+), 21 deletions(-) diff --git a/include/hamlib/rig.h b/include/hamlib/rig.h index 618d9e7c5..842da28d5 100644 --- a/include/hamlib/rig.h +++ b/include/hamlib/rig.h @@ -163,7 +163,7 @@ enum rig_errcode_e { RIG_EDOM, /*!< 17 Argument out of domain of func */ RIG_EDEPRECATED,/*!< 18 Function deprecated */ 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 }; /** @@ -340,8 +340,8 @@ enum agc_level_e { RIG_AGC_MEDIUM, RIG_AGC_AUTO, RIG_AGC_LONG, - RIG_AGC_ON, /*< Turns AGC ON -- Kenwood -- restores last level set */ - RIG_AGC_NONE /*< Rig does not have CAT AGC control */ + RIG_AGC_ON, /*!< Turns AGC ON -- Kenwood -- restores last level set */ + 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_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 { 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 *********/ /********* ENSURE ANY NEW ITEMS ARE ADDED AFTER HERE *********/ /* flags instructing the rig_get routines to use cached values when asyncio is in use */ - int use_cached_freq; /*