style: updated comments

This commit is contained in:
aZholtikov committed 2026-08-01 10:41:33 +03:00
1 parent e0d0a2894d
commit f17658bcff
5 files changed
+209 -234

No files matched your search

+7 -8
View File
@@ -215,8 +215,8 @@ if (ret != ESP_OK) {
**Возвращает:**
- `ESP_OK` - Успех
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на указатель на вектор, item или неверный индекс)
- `ESP_ERR_INVALID_STATE` - Не удалось захватить mutex (редкий системный сбой)
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на вектор, item или неверный индекс)
- `ESP_ERR_INVALID_STATE` - Не удалось захватить mutex или item равен NULL
---
@@ -271,7 +271,7 @@ if (ret != ESP_OK) {
**Возвращает:**
- `ESP_OK` - Успех
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на указатель на вектор или NULL указатель на вектор или вектор пуст)
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на вектор, NULL вектор или вектор пуст)
- `ESP_ERR_INVALID_STATE` - Не удалось захватить mutex (редкий системный сбой)
**Примечание:** Память удаленного элемента освобождается. Если размер падает ниже половины емкости, емкость уменьшается (такое же поведение, как в zh_vector_delete_item).
@@ -289,8 +289,7 @@ if (ret != ESP_OK) {
**Возвращает:**
- `ESP_OK` - Успех
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на указатель на вектор или NULL указатель на вектор или вектор пуст)
- `ESP_ERR_NO_MEM` - Ошибка выделения памяти (при перераспределении)
- `ESP_ERR_INVALID_ARG` - Неверный аргумент (NULL указатель на вектор, NULL вектор или вектор пуст)
- `ESP_ERR_INVALID_STATE` - Не удалось захватить mutex (редкий системный сбой)
**Примечание:** Память удаленного элемента освобождается, и все последующие элементы сдвигаются влево на одну позицию. Если размер падает ниже половины емкости, емкость уменьшается (такое же поведение, как в zh_vector_delete_item).
@@ -326,9 +325,9 @@ if (ret != ESP_OK) {
- `vector` - Указатель на указатель на структуру вектора (`zh_vector_t **`). Не должен быть NULL.
- `sample_struct` - Указатель на образец структуры того же типа, что и хранится в векторе. Не должен быть NULL.
- `field` - Указатель на поле внутри структуры для поиска. Должен быть действительным адресом члена внутри sample_struct.
- `item` - Указатель на поле внутри структуры (например, `&sample.id`). Используется для вычисления смещения поля внутри структуры. Не должен быть NULL.
- `size` - Размер (в байтах) поля для сравнения. Должен быть > 0.
- `item` - Указатель на значение для поиска. Не должен быть NULL.
- `value` - Указатель на значение для поиска. Не должен быть NULL.
- `start` - Начальный индекс для поиска (начиная с 0). Должен быть < размера вектора.
- `index` - Указатель на переменную для сохранения найденного индекса. Будет установлен в -1, если значение не найдено. Не должен быть NULL.
@@ -339,7 +338,7 @@ if (ret != ESP_OK) {
- `ESP_ERR_INVALID_STATE` - Не удалось захватить mutex (редкий системный сбой)
- `ESP_ERR_NOT_FOUND` - Значение не найдено (index установлен в -1)
**Примечание:** Эта функция вычисляет смещение поля внутри структуры, используя sample_struct и item указатели, затем ищет указанное значение в этом поле во всех элементах вектора, начиная с заданного индекса. Использует memcmp для сравнения. Полезно для поиска в векторах структур без копирования всей структуры.
**Примечание:** Эта функция вычисляет смещение поля внутри структуры, используя указатели `item` и `sample_struct` (смещение = `item - sample_struct`), затем ищет указанное значение `value` в этом поле во всех элементах вектора, начиная с заданного индекса. Использует memcmp для сравнения. Полезно для поиска в векторах структур без копирования всей структуры.
---