diff --git a/include/sta/utils/logger.hpp b/include/sta/utils/logger.hpp index 5c5120f..a8bcd14 100644 --- a/include/sta/utils/logger.hpp +++ b/include/sta/utils/logger.hpp @@ -15,9 +15,9 @@ namespace sta /** * @brief Construct a new Logger object * - * @param flash - * @param startAddr - * @param endAddr + * @param flash The flash chip to use for logging. + * @param startSector The index of the start sector (4096 bytes). + * @param endAddr The index of the end sector (4096 bytes). */ Logger(W25Qxx * flash, uint32_t startSector, uint32_t endSector); @@ -56,6 +56,12 @@ namespace sta */ size_t length(); + /** + * @brief Allows reading a single data point from the segment. + * + * @param idx The index of the segement. + * @return const T& The read data value. + */ const T& operator[](std::size_t idx); private: W25Qxx * flash_;