From 36692dbac704fbbb1e272d0f42254660fb7b2f24 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 26 Sep 2017 17:02:52 +1000 Subject: [PATCH] docs: Add esp_wifi_types.h items to wifi API reference Previously only items defined esp_wifi.h in esp_wifi_crypto_types.h were including in documentation reference. --- components/esp32/include/esp_wifi_types.h | 4 ++-- docs/Doxyfile | 1 + docs/api-reference/wifi/esp_wifi.rst | 2 ++ 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/components/esp32/include/esp_wifi_types.h b/components/esp32/include/esp_wifi_types.h index 61161037ce..438ad01827 100755 --- a/components/esp32/include/esp_wifi_types.h +++ b/components/esp32/include/esp_wifi_types.h @@ -61,7 +61,7 @@ typedef enum { WIFI_AUTH_MAX } wifi_auth_mode_t; -enum { +typedef enum { WIFI_REASON_UNSPECIFIED = 1, WIFI_REASON_AUTH_EXPIRE = 2, WIFI_REASON_AUTH_LEAVE = 3, @@ -91,7 +91,7 @@ enum { WIFI_REASON_AUTH_FAIL = 202, WIFI_REASON_ASSOC_FAIL = 203, WIFI_REASON_HANDSHAKE_TIMEOUT = 204, -}; +} wifi_err_reason_t; typedef enum { WIFI_SECOND_CHAN_NONE = 0, /**< the channel width is HT20 */ diff --git a/docs/Doxyfile b/docs/Doxyfile index c33ecbc9b2..2a91d72b79 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -25,6 +25,7 @@ INPUT = \ ## Wi-Fi - API Reference ## ../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 \ diff --git a/docs/api-reference/wifi/esp_wifi.rst b/docs/api-reference/wifi/esp_wifi.rst index 976893e5e4..29ecb3e3b6 100644 --- a/docs/api-reference/wifi/esp_wifi.rst +++ b/docs/api-reference/wifi/esp_wifi.rst @@ -22,4 +22,6 @@ API Reference ------------- .. include:: /_build/inc/esp_wifi.inc +.. include:: /_build/inc/esp_wifi_types.inc +