diff --git a/src/OSTimer.cpp b/src/OSTimer.cpp index 3c25abdd9..f6739d75e 100644 --- a/src/OSTimer.cpp +++ b/src/OSTimer.cpp @@ -31,12 +31,12 @@ static void IRAM_ATTR onTimer() /** * Schedules a hardware callback function to be executed after a specified delay. - * + * * @param callback The function to be executed. * @param param1 The first parameter to be passed to the function. * @param param2 The second parameter to be passed to the function. * @param delayMsec The delay time in milliseconds before the function is executed. - * + * * @return True if the function was successfully scheduled, false otherwise. */ bool scheduleHWCallback(PendableFunction callback, void *param1, uint32_t param2, uint32_t delayMsec) diff --git a/src/Power.cpp b/src/Power.cpp index dac158e15..aad5b26ae 100644 --- a/src/Power.cpp +++ b/src/Power.cpp @@ -1,11 +1,12 @@ /** * @file Power.cpp - * @brief This file contains the implementation of the Power class, which is responsible for managing power-related functionality of the device. - * It includes battery level sensing, power management unit (PMU) control, and power state machine management. - * The Power class is used by the main device class to manage power-related functionality. - * - * The file also includes implementations of various battery level sensors, such as the AnalogBatteryLevel class, which assumes the battery voltage is attached via a voltage-divider to an analog input. - * + * @brief This file contains the implementation of the Power class, which is responsible for managing power-related functionality + * of the device. It includes battery level sensing, power management unit (PMU) control, and power state machine management. The + * Power class is used by the main device class to manage power-related functionality. + * + * The file also includes implementations of various battery level sensors, such as the AnalogBatteryLevel class, which assumes + * the battery voltage is attached via a voltage-divider to an analog input. + * * This file is part of the Meshtastic project. * For more information, see: https://meshtastic.org/ */ @@ -379,7 +380,7 @@ bool Power::analogInit() /** * Initializes the Power class. - * + * * @return true if the setup was successful, false otherwise. */ bool Power::setup() diff --git a/src/PowerFSM.cpp b/src/PowerFSM.cpp index 988499e14..c9c863a57 100644 --- a/src/PowerFSM.cpp +++ b/src/PowerFSM.cpp @@ -1,10 +1,10 @@ /** * @file PowerFSM.cpp * @brief Implements the finite state machine for power management. - * - * This file contains the implementation of the finite state machine (FSM) for power management. - * The FSM controls the power states of the device, including SDS (shallow deep sleep), LS (light sleep), - * NB (normal mode), and POWER (powered mode). The FSM also handles transitions between states and + * + * This file contains the implementation of the finite state machine (FSM) for power management. + * The FSM controls the power states of the device, including SDS (shallow deep sleep), LS (light sleep), + * NB (normal mode), and POWER (powered mode). The FSM also handles transitions between states and * actions to be taken upon entering or exiting each state. */ #include "PowerFSM.h" diff --git a/src/memGet.cpp b/src/memGet.cpp index 4799c7e97..0575da279 100644 --- a/src/memGet.cpp +++ b/src/memGet.cpp @@ -1,10 +1,10 @@ /** * @file memGet.cpp * @brief Implementation of MemGet class that provides functions to get memory information. - * - * This file contains the implementation of MemGet class that provides functions to get - * information about free heap, heap size, free psram and psram size. The functions are - * implemented for ESP32 and NRF52 architectures. If the platform does not have heap + * + * This file contains the implementation of MemGet class that provides functions to get + * information about free heap, heap size, free psram and psram size. The functions are + * implemented for ESP32 and NRF52 architectures. If the platform does not have heap * management function implemented, the functions return UINT32_MAX or 0. */ #include "memGet.h" @@ -60,7 +60,7 @@ uint32_t MemGet::getFreePsram() /** * @brief Returns the size of the PSRAM memory. - * + * * @return uint32_t The size of the PSRAM memory. */ uint32_t MemGet::getPsramSize() @@ -70,4 +70,4 @@ uint32_t MemGet::getPsramSize() #else return 0; #endif -} +} \ No newline at end of file diff --git a/src/xmodem.cpp b/src/xmodem.cpp index 3e4a9eb3e..852ff3453 100644 --- a/src/xmodem.cpp +++ b/src/xmodem.cpp @@ -1,17 +1,20 @@ /** * @file xmodem.cpp * @brief Implementation of XMODEM protocol for Meshtastic devices. - * - * This file contains the implementation of the XMODEM protocol for Meshtastic devices. It is based on the XMODEM implementation by Georges Menie (www.menie.org) and has been adapted for protobuf encapsulation. - * - * The XMODEM protocol is used for reliable transmission of binary data over a serial connection. This implementation supports both sending and receiving of data. - * - * The XModemAdapter class provides the main functionality for the protocol, including CRC calculation, packet handling, and control signal sending. - * + * + * This file contains the implementation of the XMODEM protocol for Meshtastic devices. It is based on the XMODEM implementation + * by Georges Menie (www.menie.org) and has been adapted for protobuf encapsulation. + * + * The XMODEM protocol is used for reliable transmission of binary data over a serial connection. This implementation supports + * both sending and receiving of data. + * + * The XModemAdapter class provides the main functionality for the protocol, including CRC calculation, packet handling, and + * control signal sending. + * * @copyright Copyright (c) 2001-2019 Georges Menie - * @author - * @author - * @date + * @author + * @author + * @date */ /*********************************************************************************************************************** * based on XMODEM implementation by Georges Menie (www.menie.org) @@ -53,7 +56,7 @@ XModemAdapter::XModemAdapter() {} /** * Calculates the CRC-16 CCITT checksum of the given buffer. - * + * * @param buffer The buffer to calculate the checksum for. * @param length The length of the buffer. * @return The calculated checksum. @@ -245,4 +248,4 @@ void XModemAdapter::handlePacket(meshtastic_XModem xmodemPacket) // Unknown control character break; } -} +} \ No newline at end of file