convert documentation format to Doxygen;

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

Hide file tree

Showing 57 changed files with 2,608 additions and 2,231 deletions.
diff --git a/CWIdTX.cpp b/CWIdTX.cpp
@@ -1,17 +1,13 @@
 // 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) 2009-2017 Jonathan Naylor, G4KLX
-*   Copyright (C) 2016 Colin Durbridge, G4EML
-*
-*/
+/*
+ * 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) 2009-2017 Jonathan Naylor, G4KLX
+ *  Copyright (C) 2016 Colin Durbridge, G4EML
+ *
+ */
 #include "Globals.h"
 #include "CWIdTX.h"
 
@@ -84,9 +80,8 @@ const struct {
 //  Public Class Members
 // ---------------------------------------------------------------------------
 
-/// <summary>
-/// Initializes a new instance of the CWIdTX class.
-/// </summary>
+/* Initializes a new instance of the CWIdTX class. */
+
 CWIdTX::CWIdTX() :
     m_poBuffer(),
     m_poLen(0U),
@@ -96,9 +91,8 @@ CWIdTX::CWIdTX() :
     /* stub */
 }
 
-/// <summary>
-/// Process local buffer and transmit on the air interface.
-/// </summary>
+/* Process local buffer and transmit on the air interface. */
+
 void CWIdTX::process()
 {
     if (m_poLen == 0U)
@@ -129,12 +123,8 @@ void CWIdTX::process()
     }
 }
 
-/// <summary>
-/// Write CW ID data to the local buffer.
-/// </summary>
-/// <param name="data"></param>
-/// <param name="length"></param>
-/// <returns></returns>
+/* Write CW ID data to the local buffer. */
+
 uint8_t CWIdTX::write(const uint8_t* data, uint8_t length)
 {
     ::memset(m_poBuffer, 0x00U, 1000U * sizeof(uint8_t));
@@ -175,9 +165,8 @@ uint8_t CWIdTX::write(const uint8_t* data, uint8_t length)
     return RSN_OK;
 }
 
-/// <summary>
-/// Helper to reset data values to defaults.
-/// </summary>
+/* Helper to reset data values to defaults. */
+
 void CWIdTX::reset()
 {
     m_poLen = 0U;

diff --git a/CWIdTX.h b/CWIdTX.h
@@ -1,39 +1,59 @@
 // 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) 2009-2015 Jonathan Naylor, G4KLX
+ *  Copyright (C) 2016 Colin Durbridge, G4EML
+ *
+ */
 /**
-* 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) 2009-2015 Jonathan Naylor, G4KLX
-*   Copyright (C) 2016 Colin Durbridge, G4EML
-*
-*/
+ * @file CWIdTX.h
+ * @ingroup modem_fw
+ * @file CWIdTX.cpp
+ * @ingroup modem_fw
+ */
 #if !defined(__CWID_TX_H__)
 #define __CWID_TX_H__
 
 #include "Defines.h"
 
 // ---------------------------------------------------------------------------
 //  Class Declaration
-//      Implements logic to transmit a CW ID.
 // ---------------------------------------------------------------------------
 
+/**
+ * @brief Implements logic to transmit a CW ID.
+ * @ingroup modem_fw
+ */
 class DSP_FW_API CWIdTX {
 public:
-    /// <summary>Initializes a new instance of the CWIdTX class.</summary>
+    /**
+     * @brief Initializes a new instance of the CWIdTX class.
+     */
     CWIdTX();
 
-    /// <summary>Process local buffer and transmit on the air interface.</summary>
+    /**
+     * @brief Process local buffer and transmit on the air interface.
+     */
     void process();
 
-    /// <summary>Write CW ID data to the local buffer.</summary>
+    /**
+     * @brief Write CW ID data to the local buffer.
+     * @param[in] data Buffer.
+     * @param length Length of buffer.
+     * @returns uint8_t Reason code.
+     */
     uint8_t write(const uint8_t* data, uint8_t length);
 
-    /// <summary>Helper to reset data values to defaults.</summary>
+    /**
+     * @brief Helper to reset data values to defaults.
+     */
     void reset();
 
 private:

diff --git a/CalRSSI.cpp b/CalRSSI.cpp
@@ -1,16 +1,12 @@
 // 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) 2016 Jonathan Naylor, G4KLX
-*
-*/
+/*
+ * 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) 2016 Jonathan Naylor, G4KLX
+ *
+ */
 #include "Globals.h"
 #include "CalRSSI.h"
 #include "Utils.h"
@@ -19,9 +15,8 @@
 //  Public Class Members
 // ---------------------------------------------------------------------------
 
-/// <summary>
-/// Initializes a new instance of the CalRSSI class.
-/// </summary>
+/* Initializes a new instance of the CalRSSI class. */
+
 CalRSSI::CalRSSI() :
     m_count(0U),
     m_accum(0U),
@@ -31,11 +26,8 @@ CalRSSI::CalRSSI() :
     /* stub */
 }
 
-/// <summary>
-/// Sample RSSI values from the air interface.
-/// </summary>
-/// <param name="rssi"></param>
-/// <param name="length"></param>
+/* Sample RSSI values from the air interface. */
+
 void CalRSSI::samples(const uint16_t* rssi, uint8_t length)
 {
     for (uint16_t i = 0U; i < length; i++) {

diff --git a/CalRSSI.h b/CalRSSI.h
@@ -1,32 +1,43 @@
 // 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.
+ * 
+ *  Copyright (C) 2016 Jonathan Naylor, G4KLX
+ *
+ */
 /**
-* 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) 2016 Jonathan Naylor, G4KLX
-*
-*/
+ * @file CalRSSI.h
+ * @ingroup modem_fw
+ * @file CalRSSI.cpp
+ * @ingroup modem_fw
+ */
 #if !defined(__CAL_RSSI_H__)
 #define __CAL_RSSI_H__
 
 #include "Defines.h"
 
 // ---------------------------------------------------------------------------
 //  Class Declaration
-//      Implements logic for RSSI calibration mode.
 // ---------------------------------------------------------------------------
 
+/**
+ * @brief Implements logic for RSSI calibration mode.
+ * @ingroup modem_fw
+ */
 class DSP_FW_API CalRSSI {
 public:
-    /// <summary>Initializes a new instance of the CalRSSI class.</summary>
+    /**
+     * @brief Initializes a new instance of the CalRSSI class.
+     */
     CalRSSI();
 
-    /// <summary>Sample RSSI values from the air interface.</summary>
+    /**
+     * @brief Sample RSSI values from the air interface.
+     * @param rssi 
+     * @param length 
+     */
     void samples(const uint16_t* rssi, uint8_t length);
 
 private:

diff --git a/Debug.h b/Debug.h
@@ -1,16 +1,16 @@
 // 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.
+ *
+ *  Copyright (C) 2015,2016,2017 Jonathan Naylor, G4KLX
+ *
+ */
 /**
-* 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 Jonathan Naylor, G4KLX
-*
-*/
+ * @file Debug.h
+ * @ingroup modem_fw
+ */
 #if !defined(__DEBUG_H__)
 #define __DEBUG_H__
 

diff --git a/Defines.h b/Defines.h
@@ -1,17 +1,17 @@
 // 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.
+ *
+ *  Copyright (C) 2015,2016,2017 Jonathan Naylor, G4KLX
+ *  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.
-*
-* @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 Jonathan Naylor, G4KLX
-*   Copyright (C) 2018 Bryan Biedenkapp, N2PLL
-*
-*/
+ * @file Defines.h
+ * @ingroup modem_fw
+ */
 #if !defined(__DEFINES_H__)
 #define __DEFINES_H__
 

diff --git a/Globals.h b/Globals.h
@@ -1,17 +1,22 @@
 // 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.
+ *
+ *  Copyright (C) 2015,2016,2017 Jonathan Naylor, G4KLX
+ *  Copyright (C) 2017-2021 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.
-*
-* @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 Jonathan Naylor, G4KLX
-*   Copyright (C) 2017-2021 Bryan Biedenkapp, N2PLL
-*
-*/
+ * @defgroup modem_fw Modem Firmware
+ * @brief Digital Voice Modem - Modem Firmware
+ * @details Firmware that is used for repeater interface boards.
+ * @ingroup modem_fw
+ * 
+ * @file Globals.h
+ * @ingroup modem_fw
+ */
 #if !defined(__GLOBALS_H__)
 #define __GLOBALS_H__
 
@@ -85,30 +90,30 @@ extern bool m_dcd;
 extern SerialPort serial;
 extern IO io;
 
-/** DMR BS */
+/* DMR BS */
 extern dmr::DMRIdleRX dmrIdleRX;
 extern dmr::DMRRX dmrRX;
 extern dmr::DMRTX dmrTX;
 
-/** DMR MS-DMO */
+/* DMR MS-DMO */
 extern dmr::DMRDMORX dmrDMORX;
 extern dmr::DMRDMOTX dmrDMOTX;
 
-/** P25 BS */
+/* P25 BS */
 extern p25::P25RX p25RX;
 extern p25::P25TX p25TX;
 
-/** NXDN BS */
+/* NXDN BS */
 extern nxdn::NXDNRX nxdnRX;
 extern nxdn::NXDNTX nxdnTX;
 
-/** Calibration */
+/* Calibration */
 extern dmr::CalDMR calDMR;
 extern p25::CalP25 calP25;
 extern nxdn::CalNXDN calNXDN;
 extern CalRSSI calRSSI;
 
-/** CW */
+/* CW */
 extern CWIdTX cwIdTX;
 
 #endif // __GLOBALS_H__