Просмотр исходного кода

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.
Angus Gratton 8 лет назад
Родитель
Сommit
36692dbac7

+ 2 - 2
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 */

+ 1 - 0
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 \

+ 2 - 0
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
+