From 9a716209b207d31fc1f19631bc3e86aa134c41f7 Mon Sep 17 00:00:00 2001 From: Alexey Zholtikov Date: Tue, 27 Jan 2026 13:30:23 +0300 Subject: [PATCH] doc: updated descriptions --- include/zh_encoder.h | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/include/zh_encoder.h b/include/zh_encoder.h index e9aa5f4..e7be1e5 100644 --- a/include/zh_encoder.h +++ b/include/zh_encoder.h @@ -42,9 +42,9 @@ extern "C" */ typedef struct { - float encoder_step; /*!< Encoder step. @note Must be greater than 0. */ - float encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */ - float encoder_max_value; /*!< Encoder max value. @note Must be greater than encoder_min_value. */ + float encoder_step; /*!< Encoder step. @note Must be greater than 0. */ + float encoder_min_value; /*!< Encoder min value. @note Must be less than encoder_max_value. */ + float encoder_max_value; /*!< Encoder max value. @note Must be greater than encoder_min_value. */ uint8_t task_priority; /*!< Task priority for the encoder isr processing. @note Minimum value is 1. */ uint8_t queue_size; /*!< Queue size for task for the encoder processing. @note Minimum value is 1. */ uint8_t a_gpio_number; /*!< Encoder A GPIO number. */ @@ -64,10 +64,10 @@ extern "C" pcnt_unit_handle_t pcnt_unit_handle; /*!< Encoder unique pcnt unit handle. */ pcnt_channel_handle_t pcnt_channel_a_handle; /*!< Encoder unique pcnt channel handle. */ pcnt_channel_handle_t pcnt_channel_b_handle; /*!< Encoder unique pcnt channel handle. */ - float encoder_step; /*!< Encoder step. */ - float encoder_position; /*!< Encoder position. */ - float encoder_min_value; /*!< Encoder min value. */ - float encoder_max_value; /*!< Encoder max value. */ + float encoder_step; /*!< Encoder step. */ + float encoder_position; /*!< Encoder position. */ + float encoder_min_value; /*!< Encoder min value. */ + float encoder_max_value; /*!< Encoder max value. */ uint8_t encoder_number; /*!< Encoder unique number. */ uint8_t s_gpio_number; /*!< Encoder button GPIO number. */ uint16_t s_gpio_debounce_time; /*!< Encoder button debounce_time. */ @@ -105,7 +105,7 @@ extern "C" typedef struct { float encoder_position; /*!< Encoder current position. */ - uint8_t encoder_number; /*!< Encoder unique number. */ + uint8_t encoder_number; /*!< Encoder unique number. */ } zh_encoder_event_on_isr_t; /** @@ -138,6 +138,8 @@ extern "C" /** * @brief Deinitialize encoder. * + * @param[in, out] handle Pointer to unique encoder handle. + * * @return ESP_OK if success or an error code otherwise. */ esp_err_t zh_encoder_deinit(zh_encoder_handle_t *handle);