diff --git a/include/hamlib/amplist.h b/include/hamlib/amplist.h index 42808d83a..b8d094d8d 100644 --- a/include/hamlib/amplist.h +++ b/include/hamlib/amplist.h @@ -27,6 +27,7 @@ //! @cond Doxygen_Suppress #define AMP_MAKE_MODEL(a,b) ((a)*100+(b)) #define AMP_BACKEND_NUM(a) ((a)/100) +//! @endcond /** @@ -38,41 +39,48 @@ * \file amplist.h * \brief Hamlib amplifier model definitions. * - * This file contains amplifier model definitions for the Hamlib amplifier API. - * Each distinct amplifier type has a unique model number (ID) and is used by - * hamlib to identify and distinguish between the different hardware drivers. - * The exact model numbers can be acquired using the macros in this file. To - * obtain a list of supported amplifier branches, one can use the statically - * defined AMP_BACKEND_LIST macro. To obtain a full list of supported - * amplifiers (including each model in every branch), the foreach_opened_amp() - * API function can be used. + * This file contains amplifier model definitions for the Hamlib amplifier + * Application Programming Interface (API). Each distinct amplifier type has + * a unique model number (ID) and is used by Hamlib to identify and + * distinguish between the different hardware drivers. The exact model + * numbers can be acquired using the macros in this file. To obtain a list of + * supported amplifier branches, one can use the statically defined + * AMP_BACKEND_LIST macro. To obtain a full list of supported amplifiers + * (including each model in every branch), the foreach_opened_amp() API + * function can be used. * * The model number, or ID, is used to tell Hamlib which amplifier the client - * whishes to use. It is done with the amp_init() API call. + * wishes to use. It is done with the amp_init() API call. */ +//! @cond Doxygen_Suppress #define AMP_MODEL_NONE 0 +//! @endcond +/* + * Hamlib + */ /** * \def AMP_MODEL_DUMMY * \brief A macro that returns the model number for the dummy backend. * - * The dummy backend, as the name suggests, is a backend which performs - * no hardware operations and always behaves as one would expect. It can - * be thought of as a hardware simulator and is very useful for testing - * client applications. - */ -/** + * The dummy backend, as the name suggests, is a backend which performs no + * hardware operations and always behaves as one would expect. It can be + * thought of as a hardware simulator and is very useful for testing client + * applications. + * * \def AMP_MODEL_NETAMPCTL - * \brief A macro that returns the model number for the Network backend. + * \brief A macro that returns the model number for the netampctl backend. * * This backend allows use of the ampctld daemon through the normal * Hamlib API. */ +//! @cond Doxygen_Suppress #define AMP_DUMMY 0 #define AMP_BACKEND_DUMMY "dummy" +//! @endcond #define AMP_MODEL_DUMMY AMP_MAKE_MODEL(AMP_DUMMY, 1) #define AMP_MODEL_NETAMPCTL AMP_MAKE_MODEL(AMP_DUMMY, 2) @@ -82,24 +90,25 @@ */ /** - * \def AMP_MODEL_ELECRAFT - * \brief A macro that returns the model number of the EasyComm 1 backend. + * \def AMP_MODEL_ELECRAFT_KPA1500 + * \brief A macro that returns the model number of the kpa1500 backend. * - * The Elecraft #1 backend can be used with amplifiers that support the - * KPA1500 protocol. + * The kpa1500 backend can be used with amplifiers that support the Elecraft + * KPA-1500 protocol. */ +//! @cond Doxygen_Suppress #define AMP_ELECRAFT 2 #define AMP_BACKEND_ELECRAFT "elecraft" +//! @endcond #define AMP_MODEL_ELECRAFT_KPA1500 AMP_MAKE_MODEL(AMP_ELECRAFT, 1) //#define AMP_MODEL_ELECRAFT_KPA500 AMP_MAKE_MODEL(AMP_ELECRAFT, 2) /** * \typedef typedef int amp_model_t * \brief Convenience type definition for amplifier model. -*/ + */ typedef int amp_model_t; -//! @endcond #endif /* _AMPLIST_H */