Run the formatter.

Author: SFE-Brudnerd

src/sfTk/sfTkISerial.h

@@ -1,23 +1,26 @@
 /**
  * @file sfTkISerial.h
  * @brief Header file for the SparkFun Toolkit Base Serial Interface Definition.
- * 
+ *
  * This file contains the interface declaration for basic serial read/write.
- * 
+ *
  * @author SparkFun Electronics
  * @date 2025
  * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
  *
- * SPDX-License-Identifier: MIT 
+ * SPDX-License-Identifier: MIT
  */
 
 #pragma once
+
+// clang-format off
 #include "sfTkError.h"
 #include <cstdint>
+// clang-format on
 
 /**
  * @brief A base value for serial errors. All serial errors are greater than this value, in the 2000 range
- * 
+ *
  */
 const sfTkError_t ksfTkErrBaseSerial = 0x2000;
 
@@ -28,41 +31,40 @@ const sfTkError_t ksfTkErrSerialNotInit = ksfTkErrFail * (ksfTkErrBaseSerial + 1
 
 /**
  * @brief Returned when a serial interface times out.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialTimeout = ksfTkErrFail * (ksfTkErrBaseSerial + 2);
 
 /**
  * @brief Returned when a serial interface does not respond.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialNoResponse = ksfTkErrFail * (ksfTkErrBaseSerial + 3);
 
 /**
  * @brief Returned when the data to be sent is too long or received is too short.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialDataTooLong = ksfTkErrFail * (ksfTkErrBaseSerial + 4);
 
 /**
  * @brief Returned when the serial settings are null, invalid, or on set/initialized.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialNullSettings = ksfTkErrFail * (ksfTkErrBaseSerial + 5);
 
 /**
  * @brief Returned when the buffer is null or invalid.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialNullBuffer = ksfTkErrFail * (ksfTkErrBaseSerial + 6);
 
 /**
  * @brief Returned when the bus is under read. Warning.
- * 
+ *
  */
 const sfTkError_t ksfTkErrSerialUnderRead = ksfTkErrBaseSerial + 7;
 
-
 class sfTkISerial
 {
   public:
@@ -71,7 +73,7 @@ class sfTkISerial
 
     /**
      * @brief Writes an array of bytes to the serial interface.
-     * 
+     *
      * @param data The data to write
      * @param length The length of the data buffer
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
@@ -80,7 +82,7 @@ class sfTkISerial
 
     /**
      * @brief Writes a single byte to the serial interface.
-     * 
+     *
      * @param data The data to write
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
      */
@@ -91,25 +93,24 @@ class sfTkISerial
 
     /**
      * @brief Reads an array of bytes from the serial interface
-     * 
+     *
      * @param data The data buffer to read into
      * @param length The length of the data buffer
      * @param readBytes[out] The number of bytes read
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
      */
     virtual sfTkError_t read(uint8_t *data, size_t length, size_t &readBytes) = 0;
-    
+
     /**
      * @brief Read a single byte from the serial interface
-     * 
+     *
      * @param data Byte to be read
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
      */
     virtual sfTkError_t read(uint8_t &data)
     {
         size_t nRead;
-        
+
         return read(&data, sizeof(data), nRead);
     }
-
 };

src/sfTk/sfTkISerialBus.h

@@ -1,21 +1,24 @@
 /**
  * @file sfTkISerialBus.h
  * @brief Header file for the SparkFun Toolkit Base Serial Bus Interface Definition.
- * 
+ *
  * This file contains the interface declaration for connecting sfTkISerial to the sfTkIBus.
- * 
+ *
  * @author SparkFun Electronics
  * @date 2025
  * @copyright Copyright (c) 2025, SparkFun Electronics Inc. This project is released under the MIT License.
  *
- * SPDX-License-Identifier: MIT 
+ * SPDX-License-Identifier: MIT
  */
 
 #pragma once
+
+// clang-format off
 #include "sfTkError.h"
 #include "sfTkIBus.h"
 #include "sfTkISerial.h"
 #include <cstdint>
+// clang-format on
 
 const uint8_t ksfTkBusTypeSerialBus = 0x03;
 
@@ -24,26 +27,26 @@ class sfTkISerialBus : sfTkIBus
   public:
     /**
      * @brief Constructor for the serial bus
-     * 
+     *
      */
     sfTkISerialBus()
     {
     }
-    
+
     virtual ~sfTkISerialBus() = default;
 
     /**
      * @brief Writes an array of bytes to the serial interface.
-     * 
+     *
      * @param data The data to write
      * @param length The length of the data buffer
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
      */
     virtual sfTkError_t write(const uint8_t *data, size_t length) = 0;
-    
+
     /**
      * @brief Writes an array of bytes to a register on the target address. Supports any address size
-     * 
+     *
      * @param devReg The device's register's address - can be any size, If nullptr, address is not sent
      * @param regLength The length of the register address. If 0, address is not sent
      * @param data The data to write
@@ -63,7 +66,7 @@ class sfTkISerialBus : sfTkIBus
 
     /**
      * @brief Read an array of bytes from the serial interface
-     * 
+     *
      * @param data The data buffer to read into
      * @param length The length of the data buffer
      * @param readBytes[out] The number of bytes read
@@ -73,15 +76,16 @@ class sfTkISerialBus : sfTkIBus
 
     /**
      * @brief Reads an array of bytes to a register on the target address. Supports any address size
-     * 
+     *
      * @param devReg The device's register's address - can be any size
      * @param regLength The length of the register address
      * @param data The data to buffer to read into
      * @param numBytes The length of the data buffer
      * @param readBytes[out] The number of bytes read
      * @return sfTkError_t Returns ksfTkErrOk on success, or ksfTkErrFail code
      */
-    virtual sfTkError_t readRegister(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes, size_t &readBytes) override
+    virtual sfTkError_t readRegister(uint8_t *devReg, size_t regLength, uint8_t *data, size_t numBytes,
+                                     size_t &readBytes) override
     {
         // Buffer valid?
         if (!data)
@@ -93,7 +97,7 @@ class sfTkISerialBus : sfTkIBus
         if (devReg != nullptr && regLength > 0)
             retVal = write(devReg, regLength);
 
-        if(retVal != ksfTkErrOk)
+        if (retVal != ksfTkErrOk)
             return retVal;
 
         // Read the data.
@@ -104,7 +108,7 @@ class sfTkISerialBus : sfTkIBus
 
     /**
      * @brief Get the type of the object
-     * 
+     *
      * @return uint8_t The type of the object
      */
     virtual uint8_t type(void) override