cleanup some errors from Doxygen port;

DVMProject · Jul 3, 2024 · 1a31a3d · 1a31a3d
1 parent 4da05d2
commit 1a31a3d
Show file tree

Hide file tree

Showing 14 changed files with 38 additions and 25 deletions.
diff --git a/FirmwareMain.cpp b/FirmwareMain.cpp
@@ -1,19 +1,15 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
-* Digital Voice Modem - Modem Firmware
-* GPLv2 Open Source. Use is subject to license terms.
-* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
-*
-* @package DVM / Modem Firmware
-* @derivedfrom MMDVM (https://github.com/g4klx/MMDVM)
-* @license GPLv2 License (https://opensource.org/licenses/GPL-2.0)
-*
-*   Copyright (C) 2015,2016,2017,2018 Jonathan Naylor, G4KLX
-*   Copyright (C) 2016 Mathis Schmieder, DB9MAT
-*   Copyright (C) 2016 Colin Durbridge, G4EML
-*   Copyright (C) 2018 Bryan Biedenkapp, N2PLL
-*
-*/
+/*
+ * Digital Voice Modem - Modem Firmware
+ * GPLv2 Open Source. Use is subject to license terms.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ *  Copyright (C) 2015,2016,2017,2018 Jonathan Naylor, G4KLX
+ *  Copyright (C) 2016 Mathis Schmieder, DB9MAT
+ *  Copyright (C) 2016 Colin Durbridge, G4EML
+ *  Copyright (C) 2018 Bryan Biedenkapp, N2PLL
+ *
+ */
 #include "Globals.h"
 
 // ---------------------------------------------------------------------------
@@ -34,33 +30,33 @@ bool m_duplex = true;
 bool m_tx = false;
 bool m_dcd = false;
 
-/** DMR BS */
+/* DMR BS */
 dmr::DMRIdleRX dmrIdleRX;
 dmr::DMRRX dmrRX;
 dmr::DMRTX dmrTX;
 
-/** DMR MS-DMO */
+/* DMR MS-DMO */
 dmr::DMRDMORX dmrDMORX;
 dmr::DMRDMOTX dmrDMOTX;
 
-/** P25 */
+/* P25 */
 p25::P25RX p25RX;
 p25::P25TX p25TX;
 
-/** NXDN */
+/* NXDN */
 nxdn::NXDNRX nxdnRX;
 nxdn::NXDNTX nxdnTX;
 
-/** Calibration */
+/* Calibration */
 dmr::CalDMR calDMR;
 p25::CalP25 calP25;
 nxdn::CalNXDN calNXDN;
 CalRSSI calRSSI;
 
-/** CW */
+/* CW */
 CWIdTX cwIdTX;
 
-/** RS232 and Air Interface I/O */
+/* RS232 and Air Interface I/O */
 SerialPort serial;
 IO io;
 

diff --git a/STM_UART.h b/STM_UART.h
@@ -49,6 +49,7 @@ class DSP_FW_API STM_UARTFIFO {
 
     /**
      * @brief 
+     * @returns uint8_t 
      */
     uint8_t get()
     {
@@ -57,6 +58,7 @@ class DSP_FW_API STM_UARTFIFO {
 
     /**
      * @brief 
+     * @param data 
      */
     void put(uint8_t data)
     {
@@ -74,6 +76,7 @@ class DSP_FW_API STM_UARTFIFO {
 
     /**
      * @brief 
+     * @returns bool 
      */
     bool isEmpty()
     {
@@ -82,6 +85,7 @@ class DSP_FW_API STM_UARTFIFO {
 
     /**
      * @brief 
+     * @returns bool 
      */
     bool isFull()
     {

diff --git a/SerialPort.h b/SerialPort.h
@@ -370,7 +370,7 @@ class DSP_FW_API SerialPort {
      * @brief Writes data to the modem flash partition.
      * @param[in] data Buffer containing data to write to flash partition.
      * @param length Length of buffer.
-     * @returns uint8_t 
+     * @returns uint8_t Reason code.
      */
     uint8_t flashWrite(const uint8_t* data, uint8_t length);
 

diff --git a/dmr/CalDMR.h b/dmr/CalDMR.h
@@ -29,6 +29,7 @@ namespace dmr
 
     /**
      * @brief Calibration States
+     * @ingroup dmr_mfw
      */
     enum DMR1KCAL {
         DMRCAL1K_IDLE,      //! Idle
@@ -40,9 +41,12 @@ namespace dmr
 
     // ---------------------------------------------------------------------------
     //  Class Declaration
-    //      Implements logic for DMR calibration mode.
     // ---------------------------------------------------------------------------
 
+    /**
+     * @brief Implements logic for DMR calibration mode.
+     * @ingroup dmr_mfw
+     */
     class DSP_FW_API CalDMR {
     public:
         /**

diff --git a/dmr/DMRDMORX.h b/dmr/DMRDMORX.h
@@ -33,6 +33,7 @@ namespace dmr
 
     /**
      * @brief DMR DMO Receiver State
+     * @ingroup dmr_mfw
      */
     enum DMORX_STATE {
         DMORXS_NONE,        //! None

diff --git a/dmr/DMRSlotRX.h b/dmr/DMRSlotRX.h
@@ -27,6 +27,7 @@ namespace dmr
 
     /**
      * @brief DMR Slot Receiver State
+     * @ingroup dmr_mfw
      */
     enum DMRRX_STATE {
         DMRRXS_NONE,        //! None

diff --git a/dmr/DMRTX.h b/dmr/DMRTX.h
@@ -30,6 +30,7 @@ namespace dmr
 
     /**
      * @brief DMR Duplex Transmitter State
+     * @ingroup dmr_mfw
      */
     enum DMRTXSTATE {
         DMRTXSTATE_IDLE,        //! Idle

diff --git a/nxdn/CalNXDN.cpp b/nxdn/CalNXDN.cpp
@@ -98,7 +98,7 @@ void CalNXDN::process()
     }
 }
 
-/* Write P25 calibration data to the local buffer. */
+/* Write NXDN calibration data to the local buffer. */
 
 uint8_t CalNXDN::write(const uint8_t* data, uint16_t length)
 {

diff --git a/nxdn/CalNXDN.h b/nxdn/CalNXDN.h
@@ -28,6 +28,7 @@ namespace nxdn
 
     /**
      * @brief Calibration States
+     * @ingroup nxdn_mfw
      */
     enum NXDNCAL1K {
         NXDNCAL1K_IDLE,     //! Idle

diff --git a/nxdn/NXDNRX.h b/nxdn/NXDNRX.h
@@ -27,6 +27,7 @@ namespace nxdn
 
     /**
      * @brief NXDN Receiver State
+     * @ingroup nxdn_mfw
      */
     enum NXDNRX_STATE {
         NXDNRXS_NONE,       //! None

diff --git a/nxdn/NXDNTX.h b/nxdn/NXDNTX.h
@@ -30,6 +30,7 @@ namespace nxdn
 
     /**
      * @brief NXDN Transmitter States
+     * @ingroup nxdn_mfw
      */
     enum NXDNTXSTATE {
         NXDNTXSTATE_NORMAL,     //! Normal

diff --git a/p25/CalP25.h b/p25/CalP25.h
@@ -27,6 +27,7 @@ namespace p25
 
     /**
      * @brief Calibration States
+     * @ingroup p25_mfw
      */
     enum P25CAL1K {
         P25CAL1K_IDLE,      //! Idle

diff --git a/p25/P25RX.h b/p25/P25RX.h
@@ -28,6 +28,7 @@ namespace p25
 
     /**
      * @brief P25 Receiver State
+     * @ingroup p25_mfw
      */
     enum P25RX_STATE {
         P25RXS_NONE,        //! None

diff --git a/p25/P25TX.h b/p25/P25TX.h
@@ -31,6 +31,7 @@ namespace p25
 
     /**
      * @brief P25 Transmitter State
+     * @ingroup p25_mfw
      */
     enum P25TXSTATE {
         P25TXSTATE_NORMAL,  //! Normal