From 504c6a09e134d556a6eb84af2fdd76f03905b862 Mon Sep 17 00:00:00 2001 From: Vikram Dattu Date: Wed, 29 Nov 2023 11:28:45 +0530 Subject: [PATCH] fix(docs): fixed doxygen warnings in few headers - non-matching arguments in `i2c_types.h` and `esp_wifi_crypto_types.h` - Fixed unended `@cond` macro in `esp_err.h` --- components/driver/i2c/include/driver/i2c_types.h | 2 +- components/esp_common/include/esp_err.h | 1 - components/esp_wifi/include/esp_wifi_crypto_types.h | 6 +++--- 3 files changed, 4 insertions(+), 5 deletions(-) diff --git a/components/driver/i2c/include/driver/i2c_types.h b/components/driver/i2c/include/driver/i2c_types.h index 8e31bbfe59..81b3c239c1 100644 --- a/components/driver/i2c/include/driver/i2c_types.h +++ b/components/driver/i2c/include/driver/i2c_types.h @@ -86,7 +86,7 @@ typedef struct { * * @param[in] i2c_slave Handle for I2C slave. * @param[out] evt_data I2C capture event data, fed by driver - * @param[in] user_ctx User data, set in `i2c_slave_register_event_callbacks()` + * @param[in] arg User data, set in `i2c_slave_register_event_callbacks()` * * @return Whether a high priority task has been waken up by this function */ diff --git a/components/esp_common/include/esp_err.h b/components/esp_common/include/esp_err.h index 30789475a5..039dc5552a 100644 --- a/components/esp_common/include/esp_err.h +++ b/components/esp_common/include/esp_err.h @@ -79,7 +79,6 @@ const char *esp_err_to_name_r(esp_err_t code, char *buf, size_t buflen); /** @cond */ void _esp_error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression) __attribute__((__noreturn__)); -/** @cond */ void _esp_error_check_failed_without_abort(esp_err_t rc, const char *file, int line, const char *function, const char *expression); #ifndef __ASSERT_FUNC diff --git a/components/esp_wifi/include/esp_wifi_crypto_types.h b/components/esp_wifi/include/esp_wifi_crypto_types.h index 1c7ec82a8f..6b41cc524a 100644 --- a/components/esp_wifi/include/esp_wifi_crypto_types.h +++ b/components/esp_wifi/include/esp_wifi_crypto_types.h @@ -134,7 +134,7 @@ typedef int (*esp_sha256_prf_t)(const unsigned char *key, int key_len, const cha * * @param key Key for HMAC operations * @param key_len Length of the key in bytes - * @param dataPointers to the data area + * @param data Pointers to the data area * @param data_len Length of the data area * @param mac Buffer for the hash (16 bytes) * Returns: 0 on success, -1 on failure @@ -327,7 +327,7 @@ typedef int (*esp_omac1_aes_128_t)(const uint8_t *key, const uint8_t *data, size * Counter Mode Cipher Block Chaining Message Authentication * Code Protocol) which is used in IEEE 802.11i RSN standard. * @param tk 128-bit Temporal Key for obtained during 4-way handshake - * @param hdr Pointer to IEEE802.11 frame headeri needed for AAD + * @param ieee80211_hdr Pointer to IEEE802.11 frame headeri needed for AAD * @param data Pointer to encrypted data buffer * @param data_len Encrypted data length in bytes * @param decrypted_len Length of decrypted data @@ -373,7 +373,7 @@ typedef int (*esp_aes_gmac_t)(const uint8_t *key, size_t keylen, const uint8_t * * @param num_elem Number of elements in the data vector * @param addr Pointers to the data areas * @param len Lengths of the data blocks - * @param mac Buffer for the hash + * @param buf Buffer for the hash * Returns: 0 on success, -1 on failure */ typedef int (*esp_sha256_vector_t)(size_t num_elem, const uint8_t *addr[], const size_t *len, uint8_t *buf);