From f7a127dbdc42a700bb21518eba93e476dd6d42e6 Mon Sep 17 00:00:00 2001 From: George Baltz N3GB Date: Tue, 9 Sep 2025 10:30:53 -0400 Subject: [PATCH] Doxygen updates. --- include/hamlib/rig.h | 6 +++--- src/misc.c | 6 ++++-- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/include/hamlib/rig.h b/include/hamlib/rig.h index b78d4ca0c..f55ccf740 100644 --- a/include/hamlib/rig.h +++ b/include/hamlib/rig.h @@ -2244,7 +2244,7 @@ struct rig_caps { int (*set_lock_mode)(RIG *rig, int mode); int (*get_lock_mode)(RIG *rig, int *mode); short timeout_retry; /*!< number of retries to make in case of read timeout errors, some serial interfaces may require this, 0 to use default value, -1 to disable */ - short morse_qsize; /* max length of morse */ + short morse_qsize; /*!< max length of morse message rig can accept in one command */ // int (*bandwidth2rig)(RIG *rig, enum bandwidth_t bandwidth); // enum bandwidth_t (*rig2bandwidth)(RIG *rig, int rigbandwidth); }; @@ -2683,10 +2683,10 @@ struct s_rig { struct rig_callbacks callbacks; /*!< registered event callbacks */ // state should really be a pointer but that's a LOT of changes involved struct rig_state state; /*!< Rig state */ -/* Data beyond this line is for hamlib internal use only, +/* Data after this line is for hamlib internal use only, * and should *NOT* be referenced by applications, as layout will change! */ - struct rig_cache *cache_addr; + struct rig_cache *cache_addr; /*!< address of rig_cache buffer */ }; diff --git a/src/misc.c b/src/misc.c index d363f0f1b..92f5c0cba 100644 --- a/src/misc.c +++ b/src/misc.c @@ -1031,11 +1031,13 @@ static const struct }; /** - * \brief check input to set_level + * \brief Check the input to rig_set_level + * \ingroup lib_internal + * * \param rig The rig handle * \param level RIG_LEVEL_* trying to set * \param val Raw input from the caller - * \param gran If not NULL, set to location of level_gran data + * \param[out] gran If not NULL, set to location of level_gran data * * \return RIG_OK if value is in range for this level, -RIG_EINVAL if not */