diff --git a/components/zh_espnow/include/zh_espnow.h b/components/zh_espnow/include/zh_espnow.h index ff4b163..4115b5f 100644 --- a/components/zh_espnow/include/zh_espnow.h +++ b/components/zh_espnow/include/zh_espnow.h @@ -44,9 +44,7 @@ extern "C" * * @note Before initialize ESP-NOW interface recommend initialize zh_espnow_init_config_t structure with default values. * - * @code - * zh_espnow_init_config_t config = ZH_ESPNOW_INIT_CONFIG_DEFAULT() - * @endcode + * @code zh_espnow_init_config_t config = ZH_ESPNOW_INIT_CONFIG_DEFAULT() @endcode */ typedef struct { @@ -85,7 +83,6 @@ extern "C" * @brief Structure for sending data to the event handler when an ESP-NOW message was sent. * * @note Should be used with ZH_ESPNOW event base and ZH_ESPNOW_ON_SEND_EVENT event. - * */ typedef struct { @@ -106,15 +103,13 @@ extern "C" } zh_espnow_event_on_recv_t; /** - * @brief Initialize ESP-NOW interface. + * @brief Initialize ESP-NOW interface. * - * @note Before initialize ESP-NOW interface recommend initialize zh_espnow_init_config_t structure with default values. + * @note Before initialize ESP-NOW interface recommend initialize zh_espnow_init_config_t structure with default values. * - * @code - * zh_espnow_init_config_t config = ZH_ESPNOW_INIT_CONFIG_DEFAULT() - * @endcode + * @code zh_espnow_init_config_t config = ZH_ESPNOW_INIT_CONFIG_DEFAULT() @endcode * - * @param[in] config Pointer to ESP-NOW initialized configuration structure. Can point to a temporary variable. + * @param[in] config Pointer to ESP-NOW initialized configuration structure. Can point to a temporary variable. * * @return * - ESP_OK if initialization was success @@ -125,7 +120,7 @@ extern "C" esp_err_t zh_espnow_init(const zh_espnow_init_config_t *config); /** - * @brief Deinitialize ESP-NOW interface. + * @brief Deinitialize ESP-NOW interface. * * @return * - ESP_OK if deinitialization was success @@ -134,11 +129,11 @@ extern "C" esp_err_t zh_espnow_deinit(void); /** - * @brief Send ESP-NOW data. + * @brief Send ESP-NOW data. * - * @param[in] target Pointer to a buffer containing an eight-byte target MAC. Can be NULL for broadcast. - * @param[in] data Pointer to a buffer containing the data for send. - * @param[in] data_len Sending data length. + * @param[in] target Pointer to a buffer containing an eight-byte target MAC. Can be NULL for broadcast. + * @param[in] data Pointer to a buffer containing the data for send. + * @param[in] data_len Sending data length. * * @note The function will return an ESP_ERR_INVALID_STATE error if less than 10% of the size set at initialization remains in the message queue. * diff --git a/components/zh_espnow/version.txt b/components/zh_espnow/version.txt index 7e099ec..afaf360 100644 --- a/components/zh_espnow/version.txt +++ b/components/zh_espnow/version.txt @@ -1 +1 @@ -1.2.6 \ No newline at end of file +1.0.0 \ No newline at end of file diff --git a/components/zh_espnow/zh_espnow.c b/components/zh_espnow/zh_espnow.c index 0225188..b107791 100644 --- a/components/zh_espnow/zh_espnow.c +++ b/components/zh_espnow/zh_espnow.c @@ -1,6 +1,7 @@ /** * @file * The main code of the zh_espnow component. + * */ #include "zh_espnow.h"