Diff: Utilities/crc.hpp

Revision:

7:471901a04573

Parent:

6:a8c83a2e6fa4

--- a/Utilities/crc.hpp	Wed Jan 23 13:11:04 2019 -0600
+++ b/Utilities/crc.hpp	Mon Mar 04 08:10:00 2019 -0600
@@ -40,28 +40,28 @@
 
 namespace MaximInterface {
 
-/// Perform a CRC8 calculation.
+/// @brief Perform a CRC8 calculation.
 /// @param data Data to pass though the CRC generator.
 /// @param crc Beginning state of the CRC generator.
 /// @returns The calculated CRC8.
 MaximInterface_EXPORT uint_fast8_t calculateCrc8(uint_fast8_t data,
                                                  uint_fast8_t crc = 0);
 
-/// Perform a CRC8 calculation with variable length data.
+/// @brief Perform a CRC8 calculation with variable length data.
 /// @param[in] data Data array to pass through the CRC generator.
 /// @param crc Beginning state of the CRC generator.
 /// @returns The calculated CRC8.
 MaximInterface_EXPORT uint_fast8_t calculateCrc8(span<const uint_least8_t> data,
                                                  uint_fast8_t crc = 0);
 
-/// Perform a CRC16 calculation.
+/// @brief Perform a CRC16 calculation.
 /// @param data Data to pass though the CRC generator.
 /// @param crc Beginning state of the CRC generator.
 /// @returns The calculated CRC16.
 MaximInterface_EXPORT uint_fast16_t calculateCrc16(uint_fast8_t data,
                                                    uint_fast16_t crc = 0);
 
-/// Perform a CRC16 calculation with variable length data.
+/// @brief Perform a CRC16 calculation with variable length data.
 /// @param[in] data Data array to pass through the CRC generator.
 /// @param crc Beginning state of the CRC generator.
 /// @returns The calculated CRC16.