docs: Remove internal header esp_wifi_crypto_types.h from documentation

diff --git a/components/esp32/include/esp_wifi_crypto_types.h b/components/esp32/include/esp_wifi_crypto_types.h
index 10a55a708881f93e3e86116ae97daf2853511e5b..e1f2cf824cbb202b6188752ca2de4dc9a6d2e2ce 100644 (file)
--- a/components/esp32/include/esp_wifi_crypto_types.h
+++ b/components/esp32/include/esp_wifi_crypto_types.h
@@ -16,15 +16,21 @@
 #ifndef __ESP_WIFI_CRYPTO_TYPES_H__
 #define __ESP_WIFI_CRYPTO_TYPES_H__
 
+/* This is an internal API header for configuring the implementation used for WiFi cryptographic
+   operations.
+
+   During normal operation, you don't need to use any of these types or functions in this header.
+   See esp_wifi.h & esp_wifi_types.h instead.
+*/
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /*
- * This enumation is about alorigthm will be set when do crypt hash 
- * operation.When do wpa2 connecting, after invoke crypto_hash_xxx of
- * fast_crypto_hash_xxx API, it will do relation crypt operation according
- * to the enumation.
+ * Enumeration for hash operations.
+ * When WPA2 is connecting, this enum is used to
+ * request a hash algorithm via crypto_hash_xxx functions.
  */
 typedef enum {
     ESP_CRYPTO_HASH_ALG_MD5, ESP_CRYPTO_HASH_ALG_SHA1,
@@ -33,10 +39,9 @@ typedef enum {
 }esp_crypto_hash_alg_t;
 
 /*
- * This enumation is about alorigthm will be set when do crypt cipher 
- * operation.When do wpa2 connecting, after invoke crypto_cipher_xxx of
- * fast_crypto_cipher_xxx API, it will do relation crypt operation according
- * to the enumation.
+ * Enumeration for block cipher operations.
+ * When WPA2 is connecting, this enum is used to request a block
+ * cipher algorithm via crypto_cipher_xxx functions.
  */
 typedef enum {
     ESP_CRYPTO_CIPHER_NULL, ESP_CRYPTO_CIPHER_ALG_AES, ESP_CRYPTO_CIPHER_ALG_3DES,
@@ -293,7 +298,7 @@ typedef struct {
     esp_crypto_cipher_deinit_t crypto_cipher_deinit;          /**< function used to free context when use TLSV1 */
     esp_sha256_vector_t sha256_vector;                        /**< function used to do X.509v3 certificate parsing and processing */
     esp_crypto_mod_exp_t crypto_mod_exp;                      /**< function used to do key exchange when use TLSV1 */
-}wpa2_crypto_funcs_t;
+} wpa2_crypto_funcs_t;
 
 #ifdef __cplusplus
 }

diff --git a/docs/Doxyfile b/docs/Doxyfile
index 2a91d72b79c0f89d5a81da1b50181f585d3f560e..7b5e1d4d517fedd9d42bd663348ffdf0faf62bb8 100644 (file)
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -26,7 +26,6 @@ INPUT = \
     ##
     ../components/esp32/include/esp_wifi.h \
     ../components/esp32/include/esp_wifi_types.h \
-    ../components/esp32/include/esp_wifi_crypto_types.h \
     ../components/esp32/include/esp_smartconfig.h \
     ../components/esp32/include/esp_now.h \
     ## Bluetooth - API Reference