From bb0a99ac2b6298440a0638b4bf5cfee4340f7fc2 Mon Sep 17 00:00:00 2001 From: Alexey Zholtikov Date: Thu, 30 May 2024 08:44:36 +0300 Subject: [PATCH] Updated zh_vector --- components/zh_vector/README.md | 2 +- components/zh_vector/include/zh_vector.h | 44 ++++++++++++------------ components/zh_vector/version.txt | 2 +- components/zh_vector/zh_vector.c | 1 + 4 files changed, 25 insertions(+), 24 deletions(-) diff --git a/components/zh_vector/README.md b/components/zh_vector/README.md index 7b6bfd2..4c23252 100644 --- a/components/zh_vector/README.md +++ b/components/zh_vector/README.md @@ -46,7 +46,7 @@ char example[10] = {0}; void app_main(void) { - // esp_log_level_set("zh_vector", ESP_LOG_NONE); + esp_log_level_set("zh_vector", ESP_LOG_NONE); zh_vector_init(&vector, sizeof(example), false); printf("Initial vector size is: %d\n", zh_vector_get_size(&vector)); strcpy(example, "Item 1"); diff --git a/components/zh_vector/include/zh_vector.h b/components/zh_vector/include/zh_vector.h index 9c2c4a0..c83183a 100644 --- a/components/zh_vector/include/zh_vector.h +++ b/components/zh_vector/include/zh_vector.h @@ -32,15 +32,15 @@ extern "C" } zh_vector_t; /** - * @brief Initialize vector. + * @brief Initialize vector. * - * @param[in] vector Pointer to main structure of vector data. - * @param[in] unit Size of vector item. - * @param[in] spiram SPI RAM using (true - vector will be placed in SPI RAM, false - vector will be placed in RAM). + * @param[in] vector Pointer to main structure of vector data. + * @param[in] unit Size of vector item. + * @param[in] spiram SPI RAM using (true - vector will be placed in SPI RAM, false - vector will be placed in RAM). * * @attention For using SPI RAM select “Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM)” from CONFIG_SPIRAM_USE. For ESP32 with external, SPI-connected RAM only. * - * @note If SPI RAM is not supported or not initialised via menuconfig vector will be placed in RAM regardless of the set spiram value. + * @note If SPI RAM is not supported or not initialised via menuconfig vector will be placed in RAM regardless of the set spiram value. * * @return * - ESP_OK if initialization was success @@ -50,9 +50,9 @@ extern "C" esp_err_t zh_vector_init(zh_vector_t *vector, uint16_t unit, bool spiram); /** - * @brief Deinitialize vector. Free all allocated memory. + * @brief Deinitialize vector. Free all allocated memory. * - * @param[in] vector Pointer to main structure of vector data. + * @param[in] vector Pointer to main structure of vector data. * * @return * - ESP_OK if deinitialization was success @@ -62,9 +62,9 @@ extern "C" esp_err_t zh_vector_free(zh_vector_t *vector); /** - * @brief Get current vector size. + * @brief Get current vector size. * - * @param[in] vector Pointer to main structure of vector data. + * @param[in] vector Pointer to main structure of vector data. * * @return * - Vector size @@ -73,10 +73,10 @@ extern "C" esp_err_t zh_vector_get_size(zh_vector_t *vector); /** - * @brief Add item at end of vector. + * @brief Add item at end of vector. * - * @param[in] vector Pointer to main structure of vector data. - * @param[in] item Pointer to item for add. + * @param[in] vector Pointer to main structure of vector data. + * @param[in] item Pointer to item for add. * * @return * - ESP_OK if add was success @@ -87,11 +87,11 @@ extern "C" esp_err_t zh_vector_push_back(zh_vector_t *vector, void *item); /** - * @brief Change item by index. + * @brief Change item by index. * - * @param[in] vector Pointer to main structure of vector data. - * @param[in] index Index of item for change. - * @param[in] item Pointer to new data of item. + * @param[in] vector Pointer to main structure of vector data. + * @param[in] index Index of item for change. + * @param[in] item Pointer to new data of item. * * @return * - ESP_OK if change was success @@ -102,10 +102,10 @@ extern "C" esp_err_t zh_vector_change_item(zh_vector_t *vector, uint16_t index, void *item); /** - * @brief Get item by index. + * @brief Get item by index. * - * @param[in] vector Pointer to main structure of vector data. - * @param[in] index Index of item for get. + * @param[in] vector Pointer to main structure of vector data. + * @param[in] index Index of item for get. * * @return * - Pointer to item @@ -114,10 +114,10 @@ extern "C" void *zh_vector_get_item(zh_vector_t *vector, uint16_t index); /** - * @brief Delete item by index and shifts all elements in vector. + * @brief Delete item by index and shifts all elements in vector. * - * @param[in] vector Pointer to main structure of vector data. - * @param[in] index Index of item for delete. + * @param[in] vector Pointer to main structure of vector data. + * @param[in] index Index of item for delete. * * @return * - ESP_OK if delete was success diff --git a/components/zh_vector/version.txt b/components/zh_vector/version.txt index 7b5753f..afaf360 100644 --- a/components/zh_vector/version.txt +++ b/components/zh_vector/version.txt @@ -1 +1 @@ -1.4.6 \ No newline at end of file +1.0.0 \ No newline at end of file diff --git a/components/zh_vector/zh_vector.c b/components/zh_vector/zh_vector.c index 05d214d..8ea7169 100644 --- a/components/zh_vector/zh_vector.c +++ b/components/zh_vector/zh_vector.c @@ -1,6 +1,7 @@ /** * @file * The main code of the zh_vector component. + * */ #include "zh_vector.h"