From 68108c12192e28efabf89b71ec95970e21cd7050 Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Thu, 18 Feb 2021 20:44:53 -0600 Subject: [PATCH 1/2] Further refinements of the Doxygen comments in amplist.h --- include/hamlib/amplist.h | 49 ++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/include/hamlib/amplist.h b/include/hamlib/amplist.h index 018997c7b..27edf06db 100644 --- a/include/hamlib/amplist.h +++ b/include/hamlib/amplist.h @@ -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 */ From 4e3d1eb9b4f4955d7c17acd5acb5977d6e93709e Mon Sep 17 00:00:00 2001 From: Nate Bargmann Date: Thu, 18 Feb 2021 20:45:47 -0600 Subject: [PATCH 2/2] Update Doxygen comments in rotlist.h --- include/hamlib/rotlist.h | 474 ++++++++++++++++++++++++--------------- 1 file changed, 287 insertions(+), 187 deletions(-) diff --git a/include/hamlib/rotlist.h b/include/hamlib/rotlist.h index 29de6eba7..cdfe840c9 100644 --- a/include/hamlib/rotlist.h +++ b/include/hamlib/rotlist.h @@ -35,46 +35,50 @@ */ /** - * \file rotlist.h - * \brief Hamlib rotator model definitions. + * \file rotlist.h + * \brief Hamlib rotator model definitions. * - * This file contains rotator model definitions for the Hamlib rotator API. - * Each distinct rotator 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 rotator branches, one can use the statically - * defined ROT_BACKEND_LIST macro. To obtain a full list of supported - * rotators (including each model in every branch), the foreach_opened_rot() - * API function can be used. + * This file contains rotator model definitions for the Hamlib rotator + * Application Programming Interface (API). Each distinct rotator 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 + * rotator branches, one can use the statically defined ROT_BACKEND_LIST macro + * (defined in configure.ac). To obtain a full list of supported rotators + * (including each model in every branch), the foreach_opened_rot() API + * function can be used. * - * The model number, or ID, is used to tell Hamlib which rotator the client - * whishes to use. It is done with the rot_init() API call. + * The model number, or ID, is used to tell Hamlib which rotator the client + * wishes to use which is done with the rot_init() API call. */ /** - * \def ROT_MODEL_NONE - * \brief A macro that returns the model number for an unknown model. + * \def ROT_MODEL_NONE + * \brief A macro that returns the model number for an unknown model. * - * The none backend, as the name suggests, does nothing...mainly for internal use + * The none backend, as the name suggests, does nothing. It is mainly for + * internal use. */ #define ROT_MODEL_NONE 0 /** - * \def ROT_MODEL_DUMMY - * \brief A macro that returns the model number for the dummy backend. + * \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. + * \def ROT_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 thought of as a hardware simulator and is very useful for testing + * client applications. */ /** - * \def ROT_MODEL_NETROTCTL - * \brief A macro that returns the model number for the Network backend. + * \brief A macro that returns the model number for the NETROTCTL backend. * - * This backend allows use of the rotctld daemon through the normal - * Hamlib API. + * \def ROT_MODEL_NETROTCTL + * + * The NETROTCTL backend allows use of the `rotctld` daemon through the normal + * Hamlib API. */ //! @cond Doxygen_Suppress #define ROT_DUMMY 0 @@ -84,30 +88,29 @@ #define ROT_MODEL_NETROTCTL ROT_MAKE_MODEL(ROT_DUMMY, 2) -/* - * Easycomm - */ - /** - * \def ROT_MODEL_EASYCOMM1 - * \brief A macro that returns the model number of the EasyComm 1 backend. + * \brief A macro that returns the model number of the EASYCOMM 1 backend. * - * The EasyComm 1 backend can be used with rotators that support the - * EASYCOMM I Standard. + * \def ROT_MODEL_EASYCOMM1 + * + * The EASYCOMM1 backend can be used with rotators that support the EASYCOMM + * I Standard. */ /** - * \def ROT_MODEL_EASYCOMM2 - * \brief A macro that returns the model number of the EasyComm 2 backend. + * \brief A macro that returns the model number of the EASYCOMM 2 backend. * - * The EasyComm 2 backend can be used with rotators that support the - * EASYCOMM II Standard. + * \def ROT_MODEL_EASYCOMM2 + * + * The EASYCOMM2 backend can be used with rotators that support the EASYCOMM + * II Standard. */ /** - * \def ROT_MODEL_EASYCOMM3 - * \brief A macro that returns the model number of the EasyComm 3 backend. + * \brief A macro that returns the model number of the EASYCOMM 3 backend. * - * The EasyComm 3 backend can be used with rotators that support the - * EASYCOMM III Standard. + * \def ROT_MODEL_EASYCOMM3 + * + * The EASYCOMM3 backend can be used with rotators that support the EASYCOMM + * III Standard. */ //! @cond Doxygen_Suppress #define ROT_EASYCOMM 2 @@ -119,11 +122,12 @@ /** - * \def ROT_MODEL_FODTRACK - * \brief A macro that returns the model number of the Fodtrack backend. + * \brief A macro that returns the model number of the FODTRACK backend. * - * The Fodtrack backend can be used with rotators that support the - * FODTRACK Standard. + * \def ROT_MODEL_FODTRACK + * + * The FODTRACK backend can be used with rotators that support the FODTRACK + * Standard. */ //! @cond Doxygen_Suppress #define ROT_FODTRACK 3 @@ -133,39 +137,44 @@ /** - * \def ROT_MODEL_ROTOREZ - * \brief A macro that returns the model number of the Rotor-EZ backend. + * \brief A macro that returns the model number of the ROTOREZ backend. * - * The Rotor-EZ backend can be used with Hy-Gain rotators that support - * the extended DCU command set by Idiom Press Rotor-EZ board. + * \def ROT_MODEL_ROTOREZ + * + * The ROTOREZ backend can be used with Hy-Gain rotators that support the + * extended DCU command set by the Idiom Press Rotor-EZ board. */ /** - * \def ROT_MODEL_ROTORCARD - * \brief A macro that returns the model number of the Rotor Card backend. + * \brief A macro that returns the model number of the ROTORCARD backend. * - * The Rotor-EZ backend can be used with Yaesu rotators that support the - * extended DCU command set by Idiom Press Rotor Card board. + * \def ROT_MODEL_ROTORCARD + * + * The ROTORCARD backend can be used with Yaesu rotators that support the + * extended DCU command set by the Idiom Press Rotor Card board. */ /** - * \def ROT_MODEL_DCU - * \brief A macro that returns the model number of the DCU backend. + * \brief A macro that returns the model number of the DCU backend. * - * The Rotor-EZ backend can be used with rotators that support the DCU - * command set by Hy-Gain (currently the DCU-1). + * \def ROT_MODEL_DCU + * + * The DCU backend can be used with rotators that support the DCU command set + * by Hy-Gain (currently the DCU-1). */ /** - * \def ROT_MODEL_ERC - * \brief A macro that returns the model number of the ERC backend. + * \brief A macro that returns the model number of the ERC backend. * - * The Rotor-EZ backend can be used with rotators that support the DCU - * command set by DF9GR (currently the ERC). + * \def ROT_MODEL_ERC + * + * The ERC backend can be used with rotators that support the DCU command set + * by DF9GR (currently the ERC). */ /** - * \def ROT_MODEL_RT21 - * \brief A macro that returns the model number of the RT21 backend. + * \brief A macro that returns the model number of the RT21 backend. * - * The Rotor-EZ backend can be used with rotators that support the DCU - * command set by Green Heron (currently the RT-21). + * \def ROT_MODEL_RT21 + * + * The RT21 backend can be used with rotators that support the DCU command set + * by Green Heron (currently the RT-21). */ //! @cond Doxygen_Suppress #define ROT_ROTOREZ 4 @@ -179,11 +188,12 @@ /** - * \def ROT_MODEL_SARTEK1 - * \brief A macro that returns the model number of the SARtek-1 backend. + * \brief A macro that returns the model number of the SARTEK1 backend. * - * The sartek backend can be used with rotators that support the SARtek - * protocol. + * \def ROT_MODEL_SARTEK1 + * + * The SARTEK1 backend can be used with rotators that support the SARtek + * protocol. */ //! @cond Doxygen_Suppress #define ROT_SARTEK 5 @@ -193,62 +203,101 @@ /** - * \def ROT_MODEL_GS232A - * \brief A macro that returns the model number of the GS-232A backend. + * \brief A macro that returns the model number of the GS232A backend. * - * The GS-232A backend can be used with rotators that support the GS-232A - * protocol. + * \def ROT_MODEL_GS232A + * + * The GS232A backend can be used with rotators that support the GS-232A + * protocol. */ /** - * \def ROT_MODEL_GS232_GENERIC - * \brief A macro that returns the model number of the GS-232 backend. + * \brief A macro that returns the model number of the GS232 backend. * - * The GS-232 backend can be used with rotators that support the generic (even if not coded correctly) GS-232 - * protocol. + * \def ROT_MODEL_GS232_GENERIC + * + * The GS232_GENERIC backend can be used with rotators that support the + * generic (even if not coded correctly) GS-232 protocol. */ /** - * \def ROT_MODEL_GS232B - * \brief A macro that returns the model number of the GS-232B backend. + * \brief A macro that returns the model number of the GS232B backend. * - * The GS-232B backend can be used with rotators that support the GS-232B - * protocol. + * \def ROT_MODEL_GS232B + * + * The GS232B backend can be used with rotators that support the GS232B + * protocol. */ /** - * \def ROT_MODEL_F1TETRACKER - * \brief A macro that returns the model number of the F1TETRACKER backend. + * \brief A macro that returns the model number of the F1TETRACKER backend. * - * The F1TETRACKER backend can be used with rotators that support the - * F1TETRACKER protocol. - */ - /** - * \def ROT_MODEL_GS23 - * \brief A macro that returns the model number of the GS23 backend. + * \def ROT_MODEL_F1TETRACKER * - * The GS23 backend can be used with rotators that support the - * GS23 protocol. + * The F1TETRACKER backend can be used with rotators that support the F1TE + * Tracker protocol. */ - /** - * \def ROT_MODEL_GS232 - * \brief A macro that returns the model number of the GS232 backend. +/** + * \brief A macro that returns the model number of the GS23 backend. * - * The GS232 backend can be used with rotators that support the - * GS232 protocol. - */ - /** - * \def ROT_MODEL_LVB - * \brief A macro that returns the model number of the LVB TRACKER backend. + * \def ROT_MODEL_GS23 * - * The AMSAT LVB TRACKER backend can be used with rotators that support the - * AMSAT LVB TRACKER GS232 based protocol. + * The GS23 backend can be used with rotators that support the GS-23 protocol. */ - /** - * \def ROT_MODEL_ST2 - * \brief A macro that returns the model number of the Fox Delta ST2 backend. +/** + * \brief A macro that returns the model number of the GS232 backend. * - * The Fox Delta ST2 backend can be used with rotators that support the - * Fox Delta ST2 GS232 based protocol. + * \def ROT_MODEL_GS232 + * + * The GS232 backend can be used with rotators that support the GS-232 + * protocol. */ - +/** + * \brief A macro that returns the model number of the LVB backend. + * + * \def ROT_MODEL_LVB + * + * The LVB backend can be used with rotators that support the G6LVB AMSAT LVB + * Tracker GS-232 based protocol. + */ +/** + * \brief A macro that returns the model number of the ST2 backend. + * + * \def ROT_MODEL_ST2 + * + * The ST2 backend can be used with rotators that support the Fox Delta ST2 + * GS-232 based protocol. + */ +/** + * \brief A macro that returns the model number of the GS232A_AZ Azimuth backend. + * + * \def ROT_MODEL_GS232A_AZ + * + * The GS232A_AZ backend can be used with azimuth rotators that support the + * GS-232A protocol. + */ +/** + * \brief A macro that returns the model number of the GS232A_EL Elevation backend. + * + * \def ROT_MODEL_GS232A_EL + * + * The GS232A_EL backend can be used with elevation rotators that support the + * GS-232A protocol. + */ +/** + * \brief A macro that returns the model number of the GS232B_AZ Azimuth backend. + * + * \def ROT_MODEL_GS232B_AZ + * + * The GS232B_AZ backend can be used with azimuth rotators that support the + * GS-232B protocol. + */ +/** + * \brief A macro that returns the model number of the GS232B_EL Elevation backend. + * + * \def ROT_MODEL_GS232B_EL + * + * The GS232B_EL backend can be used with elevation rotators that support the + * GS-232B protocol. + */ + //! @cond Doxygen_Suppress #define ROT_GS232A 6 #define ROT_BACKEND_GS232A "gs232a" @@ -266,11 +315,14 @@ #define ROT_MODEL_GS232B_AZ ROT_MAKE_MODEL(ROT_GS232A, 11) #define ROT_MODEL_GS232B_EL ROT_MAKE_MODEL(ROT_GS232A, 12) + /** - * \def ROT_MODEL_PCROTOR - * \brief A macro that returns the model number of the PcRotor/WA6UFQ backend. + * \brief A macro that returns the model number of the PCROTOR backend. * - * The kit backend can be used with home brewed rotators. + * \def ROT_MODEL_PCROTOR + * + * The PCROTOR backend is a member of the kit backend group that can be used + * with home brewed rotators. */ //! @cond Doxygen_Suppress #define ROT_KIT 7 @@ -280,8 +332,12 @@ /** - * \def ROT_MODEL_HD1780 - * \brief A macro that returns the model number of the HD 1780 backend. + * \brief A macro that returns the model number of the HD1780 backend. + * + * \def ROT_MODEL_HD1780 + * + * The HD1780 backend can be used with rotators that support the Heathkit + * HD-1780 protocol. */ //! @cond Doxygen_Suppress #define ROT_HEATHKIT 8 @@ -291,22 +347,28 @@ /** - * \def ROT_MODEL_SPID_ROT2PROG - * \brief A macro that returns the model number of the ROT2PROG backend. + * \brief A macro that returns the model number of the ROT2PROG backend. * - * The SPID backend can be used with rotators that support the SPID protocol. + * \def ROT_MODEL_SPID_ROT2PROG + * + * The SPID_ROT2PROG backend can be used with rotators that support the SPID + * azimuth and elevation protocol. */ /** - * \def ROT_MODEL_SPID_ROT1PROG - * \brief A macro that returns the model number of the ROT1PROG backend. + * \brief A macro that returns the model number of the ROT1PROG backend. * - * The SPID backend can be used with rotators that support the SPID protocol. + * \def ROT_MODEL_SPID_ROT1PROG + * + * The SPID_ROT1PROG backend can be used with rotators that support the SPID + * azimuth protocol. */ /** - * \def ROT_MODEL_SPID_MD01_ROT2PROG - * \brief A macro that returns the model number of the MD-01/02 (ROT2PROG protocol) backend. + * \brief A macro that returns the model number of the SPID_MD01_ROT2PROG backend. * - * The SPID backend can be used with rotators that support the SPID protocol. + * \def ROT_MODEL_SPID_MD01_ROT2PROG + * + * The SPID_MD01_ROT2PROG backend can be used with rotators that support the + * extended SPID ROT2PROG azimuth and elevation protocol. */ //! @cond Doxygen_Suppress #define ROT_SPID 9 @@ -318,11 +380,30 @@ /** - * \def ROT_MODEL_RC2800 - * \brief A macro that returns the model number of the RC2800 backend. + * \brief A macro that returns the model number of the RC2800 backend. * - * The M2 backend can be used with rotators that support the RC2800 protocol - * and alike. + * \def ROT_MODEL_RC2800 + * + * The RC2800 backend can be used with rotators that support the M2 (M + * Squared) RC2800 protocol. + */ +/** + * \brief A macro that returns the model number of the RC2800_EARLY_AZ + * backend. + * + * \def ROT_MODEL_RC2800_EARLY_AZ + * + * The RC2800_EARLY_AZ backend can be used with rotators that support the M2 + * (M Squared) RC2800 early azimuth protocol. + */ +/** + * \brief A macro that returns the model number of the RC2800_EARLY_AZEL + * backend. + * + * \def ROT_MODEL_RC2800_EARLY_AZEL + * + * The RC2800_EARLY_AZEL backend can be used with rotators that support the M2 + * (M Squared) RC2800 early azimuth and elevation protocol. */ //! @cond Doxygen_Suppress #define ROT_M2 10 @@ -334,16 +415,20 @@ /** - * \def ROT_MODEL_RCI_AZEL - * \brief A macro that returns the model number of the RCI_AZEL backend. + * \brief A macro that returns the model number of the RCI_AZEL backend. * - * The ARS backend can be used with rotators that support the ARS protocol. + * \def ROT_MODEL_RCI_AZEL + * + * The RCI_AZEL backend can be used with rotators that support the ARS azimuth + * and elevation protocol. */ /** - * \def ROT_MODEL_RCI_AZ - * \brief A macro that returns the model number of the RCI_AZ backend. + * \brief A macro that returns the model number of the RCI_AZ backend. * - * The ARS backend can be used with rotators that support the ARS protocol. + * \def ROT_MODEL_RCI_AZ + * + * The RCI_AZ backend can be used with rotators that support the ARS azimuth + * protocol. */ //! @cond Doxygen_Suppress #define ROT_ARS 11 @@ -354,11 +439,12 @@ /** - * \def ROT_MODEL_IF100 - * \brief A macro that returns the model number of the IF-100 backend. + * \brief A macro that returns the model number of the IF100 backend. * - * The AMSAT backend can be used with rotators that support, among other, the - * IF-100 interface. + * \def ROT_MODEL_IF100 + * + * The IF100 backend can be used with rotators that support the AMSAT IF-100 + * interface. */ //! @cond Doxygen_Suppress #define ROT_AMSAT 12 @@ -368,11 +454,12 @@ /** - * \def ROT_MODEL_TS7400 - * \brief A macro that returns the model number of the TS7400 backend. + * \brief A macro that returns the model number of the TS7400 backend. * - * The TS-7400 backend supports and embedded ARM board using the TS-7400 - * Linux board. More information is at http://www.embeddedarm.com + * \def ROT_MODEL_TS7400 + * + * The TS7400 backend supports an embedded ARM board using the TS-7400 Linux + * board. More information is at https://www.embeddedarm.com */ //! @cond Doxygen_Suppress #define ROT_TS7400 13 @@ -382,11 +469,12 @@ /** - * \def ROT_MODEL_NEXSTAR - * \brief A macro that returns the model number of the NEXSTAR backend. + * \brief A macro that returns the model number of the NEXSTAR backend. * - * The CELESTRON backend can be used with rotators that support the Celestron - * protocol and alike. + * \def ROT_MODEL_NEXSTAR + * + * The NEXSTAR backend can be used with rotators that support the Celestron + * NexStar protocol and alike. */ //! @cond Doxygen_Suppress #define ROT_CELESTRON 14 @@ -396,11 +484,12 @@ /** - * \def ROT_MODEL_ETHER6 - * \brief A macro that returns the model number of the Ether6 backend. + * \brief A macro that returns the model number of the ETHER6 backend. * - * The Ether6 backend can be used with rotators that support the Ether6 - * protocol and alike. + * \def ROT_MODEL_ETHER6 + * + * The ETHER6 backend can be used with rotators that support the Ether6 + * protocol. */ //! @cond Doxygen_Suppress #define ROT_ETHER6 15 @@ -410,11 +499,12 @@ /** - * \def ROT_MODEL_CNCTRK - * \brief A macro that returns the model number of the CNCTRK backend. + * \brief A macro that returns the model number of the CNCTRK backend. * - * The CNCTRK backend can be used with rotators that support the LinuxCNC - * running Axis GUI interface. + * \def ROT_MODEL_CNCTRK + * + * The CNCTRK backend can be used with rotators that support the LinuxCNC + * running Axis GUI interface. */ //! @cond Doxygen_Suppress #define ROT_CNCTRK 16 @@ -424,39 +514,46 @@ /** - * \def ROT_MODEL_PROSISTEL_D_AZ - * \brief A macro that returns the model number of the PROSISTEL D azimuth backend. + * \brief A macro that returns the model number of the PROSISTEL_D_AZ backend. * + * \def ROT_MODEL_PROSISTEL_D_AZ + * + * The PROSISTEL_D_AZ backend can be used with rotators that support the Prosistel + * azimuth protocol. + */ +/** + * \brief A macro that returns the model number of the PROSISTEL_D_EL backend. + * + * \def ROT_MODEL_PROSISTEL_D_EL + * + * The PROSISTEL_D_EL backend can be used with rotators that support the Prosistel + * elevation protocol. + */ +/** + * \brief A macro that returns the model number of the + * PROSISTEL_COMBI_TRACK_AZEL backend. + * + * \def ROT_MODEL_PROSISTEL_COMBI_TRACK_AZEL + * + * The PROSISTEL_AZEL_COMBI_TRACK_AZEL backend can be used with rotators that + * support the Prosistel combination azimuth and elevation protocol. */ //! @cond Doxygen_Suppress #define ROT_PROSISTEL 17 #define ROT_BACKEND_PROSISTEL "prosistel" //! @endcond #define ROT_MODEL_PROSISTEL_D_AZ ROT_MAKE_MODEL(ROT_PROSISTEL, 1) - - -/** - * \def ROT_MODEL_PROSISTEL_D_EL - * \brief A macro that returns the model number of the PROSISTEL D elevation backend. - * - */ #define ROT_MODEL_PROSISTEL_D_EL ROT_MAKE_MODEL(ROT_PROSISTEL, 2) - - -/** - * \def ROT_MODEL_PROSISTEL_AZEL_COMBO - * \brief A macro that returns the model number of the PROSISTEL Combi-Track azimuth + elevation combo backend. - * - */ #define ROT_MODEL_PROSISTEL_COMBI_TRACK_AZEL ROT_MAKE_MODEL(ROT_PROSISTEL, 3) /** - * \def ROT_MODEL_MEADE - * \brief A macro that returns the model number of the MEADE backend. + * \brief A macro that returns the model number of the MEADE backend. * - * The MEADE backen can be used with Meade telescope rotators like - * DS-2000 + * \def ROT_MODEL_MEADE + * + * The MEADE backend can be used with Meade telescope rotators like the + * DS-2000. */ //! @cond Doxygen_Suppress #define ROT_MEADE 18 @@ -465,10 +562,11 @@ #define ROT_MODEL_MEADE ROT_MAKE_MODEL(ROT_MEADE, 1) /** - * \def ROT_MODEL_IOPTRON - * \brief A macro that returns the model number of the IOPTRON backend. + * \brief A macro that returns the model number of the IOPTRON backend. * - * The IOPTRON backen can be used with IOPTRON telescope mounts + * \def ROT_MODEL_IOPTRON + * + * The IOPTRON backend can be used with IOPTRON telescope mounts. */ //! @cond Doxygen_Suppress #define ROT_IOPTRON 19 @@ -478,12 +576,12 @@ /** -+ * \def ROT_MODEL_INDI -+ * \brief A macro that returns the model number of the INDI backend. -+ * -+ * The INDI backend can be used with rotators that support, among other, the -+ * INDI interface. -+ */ + * \brief A macro that returns the model number of the INDI backend. + * + * \def ROT_MODEL_INDI + * + * The INDI backend can be used with rotators that support the INDI interface. + */ //! @cond Doxygen_Suppress #define ROT_INDI 20 #define ROT_BACKEND_INDI "indi" @@ -492,11 +590,12 @@ /** - * \def ROT_MODEL_SATEL - * \brief A macro that returns the model number of the SatEL backend. + * \brief A macro that returns the model number of the SATEL backend. * - * The SatEL backend can be used with rotators that support the VE5FP - * interface. + * \def ROT_MODEL_SATEL + * + * The SATEL backend can be used with rotators that support the VE5FP + * interface. */ //! @cond Doxygen_Suppress #define ROT_SATEL 21 @@ -508,8 +607,9 @@ /** - * \typedef typedef int rot_model_t - * \brief Convenience type definition for rotator model. + * \brief Convenience type definition for a rotator model. + * + * \typedef typedef int rot_model_t */ typedef int rot_model_t;