alexey.zholtikov/zh_vector
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Updated some comments

Browse Source
This commit is contained in:
Alexey Zholtikov 2024-06-15 14:45:54 +03:00
parent 899c3feed8
commit 62286803a6
3 changed files with 6 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -16,8 +16,6 @@
1. Do not enable SPI RAM support unless you are sure that SPI RAM is present in your ESP32 module and it is properly configured via menuconfig. 1. Do not enable SPI RAM support unless you are sure that SPI RAM is present in your ESP32 module and it is properly configured via menuconfig.
2. If SPI RAM is present via menuconfig select Component Config -> ESP PSRAM -> Support for external, SPI-connected RAM and select SPI RAM config -> SPI RAM access method -> Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM). 2. If SPI RAM is present via menuconfig select Component Config -> ESP PSRAM -> Support for external, SPI-connected RAM and select SPI RAM config -> SPI RAM access method -> Make RAM allocatable using heap_caps_malloc(…, MALLOC_CAP_SPIRAM).
## [Function description](http://zh-vector.zh.com.ru)
## Using ## Using
In an existing project, run the following command to install the component: In an existing project, run the following command to install the component:

18
include/zh_vector.h
View File

@ -1,9 +1,3 @@
/**
* @file
* Header file for the zh_vector component.
*
*/
#pragma once #pragma once
#include "stdlib.h" #include "stdlib.h"
@ -23,12 +17,12 @@ extern "C"
*/ */
typedef struct typedef struct
{ {
void **items; ///< Array of pointers of vector items. @note void **items; // Array of pointers of vector items.
uint16_t capacity; ///< Maximum capacity of the vector. @note Used to control the size of allocated memory for array of pointers of vector items. Usually equal to the current number of items in the vector. Automatically changes when items are added or deleted. uint16_t capacity; // Maximum capacity of the vector. @note Used to control the size of allocated memory for array of pointers of vector items. Usually equal to the current number of items in the vector. Automatically changes when items are added or deleted.
uint16_t size; ///< Number of items in the vector. @note Can be read with zh_vector_get_size(). uint16_t size; // Number of items in the vector. @note Can be read with zh_vector_get_size().
uint16_t unit; ///< Vector item size. @note Possible values from 1 to 65536. uint16_t unit; // Vector item size. @note Possible values from 1 to 65536.
bool status; ///< Vector initialization status flag. @note Used to prevent execution of vector functions without prior vector initialization. bool status; // Vector initialization status flag. @note Used to prevent execution of vector functions without prior vector initialization.
bool spi_ram; ///< SPI RAM using status flag. @note True - vector will be placed in SPI RAM, false - vector will be placed in RAM. bool spi_ram; // SPI RAM using status flag. @note True - vector will be placed in SPI RAM, false - vector will be placed in RAM.
} zh_vector_t; } zh_vector_t;
/** /**

6
zh_vector.c
View File

@ -1,9 +1,3 @@
/**
* @file
* The main code of the zh_vector component.
*
*/
#include "zh_vector.h" #include "zh_vector.h"
static const char *TAG = "zh_vector"; static const char *TAG = "zh_vector";