From 19194f612dea400511c99484f6734bc257451868 Mon Sep 17 00:00:00 2001 From: Mahavir Jain Date: Thu, 24 Mar 2022 21:05:05 +0530 Subject: [PATCH] docs: Add esp_tls_errors.h to API reference list Closes DOC-2797 --- docs/doxygen/Doxyfile | 1 + docs/en/api-reference/protocols/esp_tls.rst | 1 + docs/en/api-reference/protocols/mqtt.rst | 2 +- 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 9d94f5e1ab..d26d10797c 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -116,6 +116,7 @@ INPUT = \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif.h \ $(PROJECT_PATH)/components/esp_netif/include/esp_netif_net_stack.h \ $(PROJECT_PATH)/components/esp-tls/esp_tls.h \ + $(PROJECT_PATH)/components/esp-tls/esp_tls_errors.h \ $(PROJECT_PATH)/components/mqtt/esp-mqtt/include/mqtt_client.h \ $(PROJECT_PATH)/components/lwip/include/apps/ping/ping_sock.h \ $(PROJECT_PATH)/components/lwip/include/apps/esp_sntp.h \ diff --git a/docs/en/api-reference/protocols/esp_tls.rst b/docs/en/api-reference/protocols/esp_tls.rst index 979e5363bd..1dac78860f 100644 --- a/docs/en/api-reference/protocols/esp_tls.rst +++ b/docs/en/api-reference/protocols/esp_tls.rst @@ -175,3 +175,4 @@ API Reference ------------- .. include-build-file:: inc/esp_tls.inc +.. include-build-file:: inc/esp_tls_errors.inc diff --git a/docs/en/api-reference/protocols/mqtt.rst b/docs/en/api-reference/protocols/mqtt.rst index 7d00a03767..5b8410700e 100644 --- a/docs/en/api-reference/protocols/mqtt.rst +++ b/docs/en/api-reference/protocols/mqtt.rst @@ -85,7 +85,7 @@ SSL If the certificate is not null-terminated then ``cert_len`` should also be set. Other SSL related configuration parameters are: - * ``use_global_ca_store``: use the global certificate store to verify server certificate, see ``esp-tls.h`` for more information + * ``use_global_ca_store``: use the global certificate store to verify server certificate, see :component_file:`esp-tls/esp_tls.h` for more information * ``client_cert_pem``: pointer to certificate data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed. * ``client_cert_len``: length of the buffer pointed to by client_cert_pem. May be 0 for null-terminated pem. * ``client_key_pem``: pointer to private key data in PEM or DER format for SSL mutual authentication, default is NULL, not required if mutual authentication is not needed.