Add/fix Doxygen comments

pull/1268/head
Daniele Forsi IU5HKX 2023-04-08 20:31:40 +02:00
rodzic 96bb604b12
commit c3d06fd043
5 zmienionych plików z 23 dodań i 8 usunięć

Wyświetl plik

@ -537,7 +537,7 @@ typedef unsigned int vfo_t;
/** \brief \c Macro to tell you if VFO can transmit */ /** \brief \c Macro to tell you if VFO can transmit */
#define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG) #define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG)
/** \brief \c TX -- alias for split tx or uplink, of VFO_CURR */ /** \brief \c TX -- alias for split tx or uplink, of VFO_CURR */
#define RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR) #define RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR)
/** \brief \c RX -- alias for split rx or downlink */ /** \brief \c RX -- alias for split rx or downlink */

Wyświetl plik

@ -33,6 +33,8 @@
#define RIG_MAKE_MODEL(a,b) ((a)*MAX_MODELS_PER_BACKEND+(b)) #define RIG_MAKE_MODEL(a,b) ((a)*MAX_MODELS_PER_BACKEND+(b))
#define RIG_BACKEND_NUM(a) ((a)/MAX_MODELS_PER_BACKEND) #define RIG_BACKEND_NUM(a) ((a)/MAX_MODELS_PER_BACKEND)
//! @endcond
/*! \file riglist.h /*! \file riglist.h
* \brief Hamlib rig(radio) model definitions. * \brief Hamlib rig(radio) model definitions.
* *
@ -49,6 +51,13 @@
* whishes to use. It is done with the rig_init() API call. * whishes to use. It is done with the rig_init() API call.
*/ */
/**
* \def RIG_MODEL_NONE
* \brief A macro that returns the model number for an unknown model.
*
* The none backend, as the name suggests, does nothing. It is mainly for
* internal use.
*/
#define RIG_MODEL_NONE 0 #define RIG_MODEL_NONE 0
/*! \def RIG_MODEL_DUMMY /*! \def RIG_MODEL_DUMMY
@ -62,9 +71,12 @@
* It has also been expanded to provide support to "virtual" type of rigs * It has also been expanded to provide support to "virtual" type of rigs
* such as the network rig control backend and W1HKJ's Flrig application. * such as the network rig control backend and W1HKJ's Flrig application.
*/ */
//! @cond Doxygen_Suppress
#define RIG_DUMMY 0 #define RIG_DUMMY 0
#define RIG_BACKEND_DUMMY "dummy" #define RIG_BACKEND_DUMMY "dummy"
//! @endcond
#define RIG_MODEL_DUMMY RIG_MAKE_MODEL(RIG_DUMMY, 1) #define RIG_MODEL_DUMMY RIG_MAKE_MODEL(RIG_DUMMY, 1)
//! @cond Doxygen_Suppress
#define RIG_MODEL_NETRIGCTL RIG_MAKE_MODEL(RIG_DUMMY, 2) #define RIG_MODEL_NETRIGCTL RIG_MAKE_MODEL(RIG_DUMMY, 2)
#define RIG_MODEL_ARMSTRONG RIG_MAKE_MODEL(RIG_DUMMY, 3) #define RIG_MODEL_ARMSTRONG RIG_MAKE_MODEL(RIG_DUMMY, 3)
#define RIG_MODEL_FLRIG RIG_MAKE_MODEL(RIG_DUMMY, 4) #define RIG_MODEL_FLRIG RIG_MAKE_MODEL(RIG_DUMMY, 4)
@ -629,7 +641,6 @@
#define RIG_GOMSPACE 35 #define RIG_GOMSPACE 35
#define RIG_BACKEND_GOMSPACE "gomspace" #define RIG_BACKEND_GOMSPACE "gomspace"
#define RIG_MODEL_GS100 RIG_MAKE_MODEL(RIG_GOMSPACE, 1) #define RIG_MODEL_GS100 RIG_MAKE_MODEL(RIG_GOMSPACE, 1)
//! @endcond
/* /*
* MDS Microwave Data Systems https://en.wikipedia.org/wiki/Microwave_Data_Systems * MDS Microwave Data Systems https://en.wikipedia.org/wiki/Microwave_Data_Systems
@ -645,6 +656,7 @@
etc. etc.
*/ */
//! @endcond
/*! \typedef typedef int rig_model_t /*! \typedef typedef int rig_model_t
\brief Convenience type definition for rig model. \brief Convenience type definition for rig model.

Wyświetl plik

@ -26,6 +26,7 @@
#define CHECK_RIG_ARG(r) (!(r) || !(r)->caps || !(r)->state.comm_state) #define CHECK_RIG_ARG(r) (!(r) || !(r)->caps || !(r)->state.comm_state)
/** /**
* \file cache.c
* \addtogroup rig * \addtogroup rig
* @{ * @{
*/ */

Wyświetl plik

@ -5708,7 +5708,7 @@ int HAMLIB_API rig_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts)
* \brief set the antenna * \brief set the antenna
* \param rig The rig handle * \param rig The rig handle
* \param vfo The target VFO * \param vfo The target VFO
* \param ant The anntena to select * \param ant The antenna to select
* \param option An option that the ant command for the rig recognizes * \param option An option that the ant command for the rig recognizes
* *
* Select the antenna connector. * Select the antenna connector.

Wyświetl plik

@ -71,7 +71,7 @@
#define TOK_STOP_BITS TOKEN_FRONTEND(22) #define TOK_STOP_BITS TOKEN_FRONTEND(22)
/** \brief Serial parity (format?) */ /** \brief Serial parity (format?) */
#define TOK_PARITY TOKEN_FRONTEND(23) #define TOK_PARITY TOKEN_FRONTEND(23)
/** \brief Serial Handshake (format?) */ /** \brief Serial Handshake (format?) */
#define TOK_HANDSHAKE TOKEN_FRONTEND(24) #define TOK_HANDSHAKE TOKEN_FRONTEND(24)
/** \brief Serial Req. To Send status */ /** \brief Serial Req. To Send status */
#define TOK_RTS_STATE TOKEN_FRONTEND(25) #define TOK_RTS_STATE TOKEN_FRONTEND(25)
@ -89,7 +89,7 @@
#define TOK_PTT_BITNUM TOKEN_FRONTEND(34) #define TOK_PTT_BITNUM TOKEN_FRONTEND(34)
/** \brief PTT share with other applications */ /** \brief PTT share with other applications */
#define TOK_PTT_SHARE TOKEN_FRONTEND(35) #define TOK_PTT_SHARE TOKEN_FRONTEND(35)
/** \brief PTT share with other applications */ /** \brief Flush with read instead of TCFLUSH */
#define TOK_FLUSHX TOKEN_FRONTEND(36) #define TOK_FLUSHX TOKEN_FRONTEND(36)
/** \brief Asynchronous data transfer support */ /** \brief Asynchronous data transfer support */
#define TOK_ASYNC TOKEN_FRONTEND(37) #define TOK_ASYNC TOKEN_FRONTEND(37)
@ -101,7 +101,7 @@
*/ */
/* rx_range_list/tx_range_list, filters, announces, has(func,lvl,..) */ /* rx_range_list/tx_range_list, filters, announces, has(func,lvl,..) */
/** \brief rig: ?? */ /** \brief rig: VFO compensation in ppm */
#define TOK_VFO_COMP TOKEN_FRONTEND(110) #define TOK_VFO_COMP TOKEN_FRONTEND(110)
/** \brief rig: Rig state poll interval in milliseconds */ /** \brief rig: Rig state poll interval in milliseconds */
#define TOK_POLL_INTERVAL TOKEN_FRONTEND(111) #define TOK_POLL_INTERVAL TOKEN_FRONTEND(111)
@ -121,11 +121,13 @@
#define TOK_AUTO_DISABLE_SCREENSAVER TOKEN_FRONTEND(126) #define TOK_AUTO_DISABLE_SCREENSAVER TOKEN_FRONTEND(126)
/** \brief rig: Disable Yaesu band select logic */ /** \brief rig: Disable Yaesu band select logic */
#define TOK_DISABLE_YAESU_BANDSELECT TOKEN_FRONTEND(127) #define TOK_DISABLE_YAESU_BANDSELECT TOKEN_FRONTEND(127)
/** \brief rig: Supporess get_freq on VFOB for satellite RIT tuning */ /** \brief rig: Suppress get_freq on VFOB for satellite RIT tuning */
#define TOK_TWIDDLE_TIMEOUT TOKEN_FRONTEND(128) #define TOK_TWIDDLE_TIMEOUT TOKEN_FRONTEND(128)
/** \brief rig: Supporess get_freq on VFOB for satellite RIT tuning */ /** \brief rig: Suppress get_freq on VFOB for satellite RIT tuning */
#define TOK_TWIDDLE_RIT TOKEN_FRONTEND(129) #define TOK_TWIDDLE_RIT TOKEN_FRONTEND(129)
/** \brief rig: Add Hz to VFOA/Main frequency set */
#define TOK_OFFSET_VFOA TOKEN_FRONTEND(130) #define TOK_OFFSET_VFOA TOKEN_FRONTEND(130)
/** \brief rig: Add Hz to VFOB/Sub frequency set */
#define TOK_OFFSET_VFOB TOKEN_FRONTEND(131) #define TOK_OFFSET_VFOB TOKEN_FRONTEND(131)
/* /*
* rotator specific tokens * rotator specific tokens