[Hamlib-commits] Hamlib -- Ham radio control libraries branch master updated. bc17a749d0bc133fe80f94c0e4fe4ab7a4835072

[Nate B. <n0...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Hamlib -- Ham radio control libraries".

The branch, master has been updated
       via  bc17a749d0bc133fe80f94c0e4fe4ab7a4835072 (commit)
       via  da5662dce350ab1e2331e7286041aef9c865bdba (commit)
      from  e7f5aa60664d8f39fdb20ba6c2e4f2431e583ca2 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit bc17a749d0bc133fe80f94c0e4fe4ab7a4835072
Merge: e7f5aa60 da5662dc
Author: Nate Bargmann <n0...@n0...>
Date:   Sun Feb 7 20:12:25 2021 -0600

    Merge pull request #534 from N0NB/doxygen_work
    
    Enable and update Doxygen comments in amplist.h


commit da5662dce350ab1e2331e7286041aef9c865bdba
Author: Nate Bargmann <n0...@n0...>
Date:   Sun Feb 7 20:10:50 2021 -0600

    Enable and update Doxygen comments in amplist.h

diff --git a/include/hamlib/amplist.h b/include/hamlib/amplist.h
index 42808d83..b8d094d8 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 */
 

-----------------------------------------------------------------------

Summary of changes:
 include/hamlib/amplist.h | 53 ++++++++++++++++++++++++++++--------------------
 1 file changed, 31 insertions(+), 22 deletions(-)


hooks/post-receive
-- 
Hamlib -- Ham radio control libraries