kopia lustrzana https://github.com/Hamlib/Hamlib
Further refinements of the Doxygen comments in amplist.h
rodzic
e59a7f0971
commit
68108c1219
|
@ -46,37 +46,42 @@
|
|||
* 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.
|
||||
* AMP_BACKEND_LIST macro (defined in configure.ac). 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
|
||||
* wishes to use. It is done with the amp_init() API call.
|
||||
* wishes to use which is done with the amp_init() API call.
|
||||
*/
|
||||
|
||||
|
||||
//! @cond Doxygen_Suppress
|
||||
#define AMP_MODEL_NONE 0
|
||||
//! @endcond
|
||||
|
||||
/*
|
||||
* Hamlib
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief A macro that returns the model number for the dummy backend.
|
||||
* \brief A macro that returns the model number for an unknown model.
|
||||
*
|
||||
* \def AMP_MODEL_NONE
|
||||
*
|
||||
* The none backend, as the name suggests, does nothing. It is mainly for
|
||||
* internal use.
|
||||
*/
|
||||
#define AMP_MODEL_NONE 0
|
||||
|
||||
|
||||
/**
|
||||
* \brief A macro that returns the model number for the DUMMY backend.
|
||||
*
|
||||
* \def AMP_MODEL_DUMMY
|
||||
*
|
||||
* 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
|
||||
* 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.
|
||||
*/
|
||||
/**
|
||||
* \brief A macro that returns the model number for the NETAMPCTL backend.
|
||||
*
|
||||
* \def AMP_MODEL_NETAMPCTL
|
||||
* \brief A macro that returns the model number for the netampctl backend.
|
||||
*
|
||||
* This backend allows use of the ampctld daemon through the normal
|
||||
* The NETAMPCTL backend allows use of the `ampctld` daemon through the normal
|
||||
* Hamlib API.
|
||||
*/
|
||||
//! @cond Doxygen_Suppress
|
||||
|
@ -87,16 +92,12 @@
|
|||
#define AMP_MODEL_NETAMPCTL AMP_MAKE_MODEL(AMP_DUMMY, 2)
|
||||
|
||||
|
||||
/*
|
||||
* Elecraft
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief A macro that returns the model number of the kpa1500 backend.
|
||||
* \brief A macro that returns the model number of the KPA1500 backend.
|
||||
*
|
||||
* \def AMP_MODEL_ELECRAFT_KPA1500
|
||||
*
|
||||
* The kpa1500 backend can be used with amplifiers that support the Elecraft
|
||||
* The KPA1500 backend can be used with amplifiers that support the Elecraft
|
||||
* KPA-1500 protocol.
|
||||
*/
|
||||
//! @cond Doxygen_Suppress
|
||||
|
@ -107,7 +108,7 @@
|
|||
//#define AMP_MODEL_ELECRAFT_KPA500 AMP_MAKE_MODEL(AMP_ELECRAFT, 2)
|
||||
|
||||
/**
|
||||
* \brief Convenience type definition for amplifier model.
|
||||
* \brief Convenience type definition for an amplifier model.
|
||||
*
|
||||
* \typedef typedef int amp_model_t
|
||||
*/
|
||||
|
|
Ładowanie…
Reference in New Issue