From 9195ed83db38ef7f1f0ba38844d460568b409941 Mon Sep 17 00:00:00 2001 From: Jamie Smith Date: Wed, 13 Dec 2023 00:06:56 -0800 Subject: [PATCH] Update code blocks to pass spell checker --- platform/include/platform/CacheAlignedBuffer.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/platform/include/platform/CacheAlignedBuffer.h b/platform/include/platform/CacheAlignedBuffer.h index 72477d14cff..50b418b7de8 100644 --- a/platform/include/platform/CacheAlignedBuffer.h +++ b/platform/include/platform/CacheAlignedBuffer.h @@ -79,27 +79,27 @@ constexpr inline size_t getNeededBackingBufferSize(size_t neededCapacity, size_t * *

Converting Code to use CacheAlignedBuffer

* For code using static arrays, like this: - * \code{.cpp} + * @code * uint8_t rxBuffer[16]; * spi.transfer_and_wait(nullptr, 0, rxBuffer, 16); - * \endcode + * @endcode * Use a StaticCacheAlignedBuffer: - * \code{.cpp} + * @code * StaticCacheAlignedBuffer rxBuffer; * spi.transfer_and_wait(nullptr, 0, rxBuffer, 16); - * \endcode + * @endcode * For code using dynamic allocation to handle unknown buffer sizes, like: - * \code{.cpp} + * @code * uint16_t * rxBuffer = new uint16_t[bufferSize]; * spi.transfer_and_wait(nullptr, 0, rxBuffer, bufferSize); * ... * delete[] rxBuffer; - * \endcode + * @endcode * use a DynamicCacheAlignedBuffer: - * \code{.cpp} + * @code * DynamicCacheAlignedBuffer rxBuffer(bufferSize); * spi.transfer_and_wait(nullptr, 0, rxBuffer, bufferSize); - * \endcode + * @endcode * * @tparam DataT Type of the data to store in the buffer. Note: %CacheAlignedBuffer is not designed for * using class types as DataT, and will not call constructors.