diff --git a/include/hamlib/amplifier.h b/include/hamlib/amplifier.h index 07548353b..990df1573 100644 --- a/include/hamlib/amplifier.h +++ b/include/hamlib/amplifier.h @@ -230,7 +230,7 @@ struct amp_caps const char *macro_name; /*!< Macro name. */ }; -//! @cond Doxygen_Suppress +//! @endcond /** @@ -259,7 +259,9 @@ struct amp_state rig_ptr_t priv; /*!< Pointer to private amplifier state data. */ rig_ptr_t obj; /*!< Internal use by hamlib++ for event handling. */ +//! @cond Doxygen_Suppress setting_t has_get_level; +//! @endcond gran_t level_gran[RIG_SETTING_MAX]; /*!< level granularity */ gran_t parm_gran[RIG_SETTING_MAX]; /*!< level granularity */ @@ -285,6 +287,7 @@ struct amp }; +//! @cond Doxygen_Suppress /* --------------- API function prototypes -----------------*/ extern HAMLIB_EXPORT(AMP *) @@ -394,6 +397,7 @@ extern HAMLIB_EXPORT(const char *) amp_strlevel(setting_t); extern HAMLIB_EXPORT(const struct confparams *) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); +//! @endcond /** diff --git a/include/hamlib/riglist.h b/include/hamlib/riglist.h index 6c74eb2d4..371b7436c 100644 --- a/include/hamlib/riglist.h +++ b/include/hamlib/riglist.h @@ -23,6 +23,8 @@ #ifndef _RIGLIST_H #define _RIGLIST_H 1 +//! @cond Doxygen_Suppress + // The rig model number is designed to fit in a 32-bit int // As of 2020-02-18 we have 33 backends defined // With a max of 1000 models per backend we get total a model number range of 1001-33001 @@ -615,6 +617,7 @@ #define RIG_ELAD 33 #define RIG_BACKEND_ELAD "elad" #define RIG_MODEL_ELAD_FDM_DUO RIG_MAKE_MODEL(RIG_ELAD, 1) +//! @endcond /* diff --git a/src/amp_reg.c b/src/amp_reg.c index 852462a17..d69004532 100644 --- a/src/amp_reg.c +++ b/src/amp_reg.c @@ -42,6 +42,7 @@ #include "register.h" +//! @cond Doxygen_Suppress #ifndef PATH_MAX # define PATH_MAX 1024 #endif @@ -66,6 +67,7 @@ DEFINE_INITAMP_BACKEND(dummy); DEFINE_INITAMP_BACKEND(kpa1500); +//! @endcond /** * \def amp_backend_list @@ -109,11 +111,11 @@ struct amp_list const struct amp_caps *caps; struct amp_list *next; }; -//! @endcond #define AMPLSTHASHSZ 16 #define HASH_FUNC(a) ((a)%AMPLSTHASHSZ) +//! @endcond /* @@ -129,6 +131,7 @@ static int amp_lookup_backend(amp_model_t amp_model); /* * Basically, this is a hash insert function that doesn't check for dup! */ +//! @cond Doxygen_Suppress int HAMLIB_API amp_register(const struct amp_caps *caps) { int hval; @@ -165,12 +168,14 @@ int HAMLIB_API amp_register(const struct amp_caps *caps) return RIG_OK; } +//! @endcond /* * Get amp capabilities. * i.e. amp_hash_table lookup */ +//! @cond Doxygen_Suppress const struct amp_caps *HAMLIB_API amp_get_caps(amp_model_t amp_model) { struct amp_list *p; @@ -185,6 +190,7 @@ const struct amp_caps *HAMLIB_API amp_get_caps(amp_model_t amp_model) return NULL; /* sorry, caps not registered! */ } +//! @endcond /* @@ -192,6 +198,7 @@ const struct amp_caps *HAMLIB_API amp_get_caps(amp_model_t amp_model) * according to BACKEND_NUM * return -1 if not found. */ +//! @cond Doxygen_Suppress static int amp_lookup_backend(amp_model_t amp_model) { int i; @@ -207,6 +214,7 @@ static int amp_lookup_backend(amp_model_t amp_model) return -1; } +//! @endcond /* @@ -215,6 +223,7 @@ static int amp_lookup_backend(amp_model_t amp_model) * and if not loaded already, load it! * This permits seamless operation in amp_init. */ +//! @cond Doxygen_Suppress int HAMLIB_API amp_check_backend(amp_model_t amp_model) { const struct amp_caps *caps; @@ -249,8 +258,10 @@ int HAMLIB_API amp_check_backend(amp_model_t amp_model) return retval; } +//! @endcond +//! @cond Doxygen_Suppress int HAMLIB_API amp_unregister(amp_model_t amp_model) { int hval; @@ -281,12 +292,14 @@ int HAMLIB_API amp_unregister(amp_model_t amp_model) return -RIG_EINVAL; /* sorry, caps not registered! */ } +//! @endcond /* * amp_list_foreach * executes cfunc on all the elements stored in the amp hash list */ +//! @cond Doxygen_Suppress int HAMLIB_API amp_list_foreach(int (*cfunc)(const struct amp_caps *, rig_ptr_t), rig_ptr_t data) @@ -310,12 +323,14 @@ int HAMLIB_API amp_list_foreach(int (*cfunc)(const struct amp_caps *, return RIG_OK; } +//! @endcond /* * amp_probe_all * called straight by amp_probe */ +//! @cond Doxygen_Suppress amp_model_t HAMLIB_API amp_probe_all(hamlib_port_t *p) { int i; @@ -336,8 +351,10 @@ amp_model_t HAMLIB_API amp_probe_all(hamlib_port_t *p) return AMP_MODEL_NONE; } +//! @endcond +//! @cond Doxygen_Suppress int amp_load_all_backends() { int i; @@ -349,12 +366,14 @@ int amp_load_all_backends() return RIG_OK; } +//! @endcond /* * amp_load_backend * Dynamically load a amp backend through dlopen mechanism */ +//! @cond Doxygen_Suppress int HAMLIB_API amp_load_backend(const char *be_name) { int status; @@ -381,3 +400,4 @@ int HAMLIB_API amp_load_backend(const char *be_name) return -EINVAL; } +//! @endcond diff --git a/src/register.c b/src/register.c index 156affbf8..0515fe87b 100644 --- a/src/register.c +++ b/src/register.c @@ -41,6 +41,7 @@ #include +//! @cond Doxygen_Suppress #ifndef PATH_MAX # define PATH_MAX 1024 #endif @@ -88,9 +89,12 @@ DEFINE_INITRIG_BACKEND(adat); DEFINE_INITRIG_BACKEND(dorji); DEFINE_INITRIG_BACKEND(barrett); DEFINE_INITRIG_BACKEND(elad); +//! @endcond #ifdef HAVE_WINRADIO +//! @cond Doxygen_Suppress DEFINE_INITRIG_BACKEND(winradio); +//! @endcond #endif @@ -160,8 +164,10 @@ struct rig_list // This size has to be > than the max# of rigs for any manufacturer // A fatal error will occur when running rigctl if this value is too small +//! @cond Doxygen_Suppress #define RIGLSTHASHSZ 65535 #define HASH_FUNC(a) ((a)%RIGLSTHASHSZ) +//! @endcond /* @@ -177,6 +183,7 @@ static int rig_lookup_backend(rig_model_t rig_model); /* * Basically, this is a hash insert function that doesn't check for dup! */ +//! @cond Doxygen_Suppress int HAMLIB_API rig_register(const struct rig_caps *caps) { int hval; @@ -216,12 +223,14 @@ int HAMLIB_API rig_register(const struct rig_caps *caps) return RIG_OK; } +//! @endcond /* * Get rig capabilities. * ie. rig_hash_table lookup */ +//! @cond Doxygen_Suppress const struct rig_caps *HAMLIB_API rig_get_caps(rig_model_t rig_model) { struct rig_list *p; @@ -236,12 +245,14 @@ const struct rig_caps *HAMLIB_API rig_get_caps(rig_model_t rig_model) return NULL; /* sorry, caps not registered! */ } +//! @endcond /* * lookup for backend index in rig_backend_list table, * according to BACKEND_NUM * return -1 if not found. */ +//! @cond Doxygen_Suppress static int rig_lookup_backend(rig_model_t rig_model) { int i; @@ -257,6 +268,7 @@ static int rig_lookup_backend(rig_model_t rig_model) return -1; } +//! @endcond /* * rig_check_backend @@ -264,6 +276,7 @@ static int rig_lookup_backend(rig_model_t rig_model) * and if not loaded already, load it! * This permits seamless operation in rig_init. */ +//! @cond Doxygen_Suppress int HAMLIB_API rig_check_backend(rig_model_t rig_model) { const struct rig_caps *caps; @@ -296,9 +309,11 @@ int HAMLIB_API rig_check_backend(rig_model_t rig_model) return retval; } +//! @endcond +//! @cond Doxygen_Suppress int HAMLIB_API rig_unregister(rig_model_t rig_model) { int hval; @@ -329,11 +344,13 @@ int HAMLIB_API rig_unregister(rig_model_t rig_model) return -RIG_EINVAL; /* sorry, caps not registered! */ } +//! @endcond /* * rig_list_foreach * executes cfunc on all the elements stored in the rig hash list */ +//! @cond Doxygen_Suppress int HAMLIB_API rig_list_foreach(int (*cfunc)(const struct rig_caps *, rig_ptr_t), rig_ptr_t data) @@ -363,8 +380,10 @@ int HAMLIB_API rig_list_foreach(int (*cfunc)(const struct rig_caps *, return RIG_OK; } +//! @endcond +//! @cond Doxygen_Suppress static int dummy_rig_probe(const hamlib_port_t *p, rig_model_t model, rig_ptr_t data) @@ -373,12 +392,14 @@ static int dummy_rig_probe(const hamlib_port_t *p, return RIG_OK; } +//! @endcond /* * rig_probe_first * called straight by rig_probe */ +//! @cond Doxygen_Suppress rig_model_t rig_probe_first(hamlib_port_t *p) { int i; @@ -401,12 +422,14 @@ rig_model_t rig_probe_first(hamlib_port_t *p) return RIG_MODEL_NONE; } +//! @endcond /* * rig_probe_all_backends * called straight by rig_probe_all */ +//! @cond Doxygen_Suppress int rig_probe_all_backends(hamlib_port_t *p, rig_probe_func_t cfunc, rig_ptr_t data) @@ -423,8 +446,10 @@ int rig_probe_all_backends(hamlib_port_t *p, return RIG_OK; } +//! @endcond +//! @cond Doxygen_Suppress int rig_load_all_backends() { int i; @@ -436,14 +461,18 @@ int rig_load_all_backends() return RIG_OK; } +//! @endcond +//! @cond Doxygen_Suppress typedef int (*backend_init_t)(rig_ptr_t); +//! @endcond /* * rig_load_backend */ +//! @cond Doxygen_Suppress int HAMLIB_API rig_load_backend(const char *be_name) { int i; @@ -468,3 +497,4 @@ int HAMLIB_API rig_load_backend(const char *be_name) return -RIG_EINVAL; } +//! @endcond diff --git a/src/rot_reg.c b/src/rot_reg.c index fa4c9c5d2..ab77990a0 100644 --- a/src/rot_reg.c +++ b/src/rot_reg.c @@ -42,6 +42,7 @@ #include "register.h" +//! @cond Doxygen_Suppress #ifndef PATH_MAX # define PATH_MAX 1024 #endif @@ -83,6 +84,7 @@ DEFINE_INITROT_BACKEND(cnctrk); DEFINE_INITROT_BACKEND(prosistel); DEFINE_INITROT_BACKEND(meade); DEFINE_INITROT_BACKEND(ioptron); +//! @endcond /** * \def rot_backend_list @@ -146,8 +148,10 @@ struct rot_list //! @endcond +//! @cond Doxygen_Suppress #define ROTLSTHASHSZ 16 #define HASH_FUNC(a) ((a)%ROTLSTHASHSZ) +//! @endcond /* @@ -163,6 +167,7 @@ static int rot_lookup_backend(rot_model_t rot_model); /* * Basically, this is a hash insert function that doesn't check for dup! */ +//! @cond Doxygen_Suppress int HAMLIB_API rot_register(const struct rot_caps *caps) { int hval; @@ -199,12 +204,14 @@ int HAMLIB_API rot_register(const struct rot_caps *caps) return RIG_OK; } +//! @endcond /* * Get rot capabilities. * i.e. rot_hash_table lookup */ +//! @cond Doxygen_Suppress const struct rot_caps *HAMLIB_API rot_get_caps(rot_model_t rot_model) { struct rot_list *p; @@ -219,6 +226,7 @@ const struct rot_caps *HAMLIB_API rot_get_caps(rot_model_t rot_model) return NULL; /* sorry, caps not registered! */ } +//! @endcond /* @@ -249,6 +257,7 @@ static int rot_lookup_backend(rot_model_t rot_model) * and if not loaded already, load it! * This permits seamless operation in rot_init. */ +//! @cond Doxygen_Suppress int HAMLIB_API rot_check_backend(rot_model_t rot_model) { const struct rot_caps *caps; @@ -283,8 +292,10 @@ int HAMLIB_API rot_check_backend(rot_model_t rot_model) return retval; } +//! @endcond +//! @cond Doxygen_Suppress int HAMLIB_API rot_unregister(rot_model_t rot_model) { int hval; @@ -315,12 +326,14 @@ int HAMLIB_API rot_unregister(rot_model_t rot_model) return -RIG_EINVAL; /* sorry, caps not registered! */ } +//! @endcond /* * rot_list_foreach * executes cfunc on all the elements stored in the rot hash list */ +//! @cond Doxygen_Suppress int HAMLIB_API rot_list_foreach(int (*cfunc)(const struct rot_caps *, rig_ptr_t), rig_ptr_t data) @@ -344,12 +357,14 @@ int HAMLIB_API rot_list_foreach(int (*cfunc)(const struct rot_caps *, return RIG_OK; } +//! @endcond /* * rot_probe_all * called straight by rot_probe */ +//! @cond Doxygen_Suppress rot_model_t HAMLIB_API rot_probe_all(hamlib_port_t *p) { int i; @@ -370,8 +385,10 @@ rot_model_t HAMLIB_API rot_probe_all(hamlib_port_t *p) return ROT_MODEL_NONE; } +//! @endcond +//! @cond Doxygen_Suppress int rot_load_all_backends() { int i; @@ -383,12 +400,14 @@ int rot_load_all_backends() return RIG_OK; } +//! @endcond /* * rot_load_backend * Dynamically load a rot backend through dlopen mechanism */ +//! @cond Doxygen_Suppress int HAMLIB_API rot_load_backend(const char *be_name) { int status; @@ -415,3 +434,4 @@ int HAMLIB_API rot_load_backend(const char *be_name) return -EINVAL; } +//! @endcond diff --git a/src/sleep.c b/src/sleep.c index 0777a0930..709f884db 100644 --- a/src/sleep.c +++ b/src/sleep.c @@ -106,8 +106,9 @@ int usleep(useconds_t usec) return 0; } + #endif // HAVE_NANOSLEEP -#pragma GCC diagnostic ignored "-Wall" #ifdef __cplusplus } #endif +/** @} */