From a8b6017ca546b815e7d34649b34ca5bed89695de Mon Sep 17 00:00:00 2001 From: Richard Allen Date: Thu, 12 Jun 2025 10:44:06 -0500 Subject: [PATCH] docs(esp_transport_ws): fix parameter name documentation --- components/tcp_transport/include/esp_transport_ws.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/components/tcp_transport/include/esp_transport_ws.h b/components/tcp_transport/include/esp_transport_ws.h index ba5eef8a11..c8997378eb 100644 --- a/components/tcp_transport/include/esp_transport_ws.h +++ b/components/tcp_transport/include/esp_transport_ws.h @@ -79,7 +79,7 @@ esp_err_t esp_transport_ws_set_subprotocol(esp_transport_handle_t t, const char * @brief Set websocket user-agent header * * @param t websocket transport handle - * @param sub_protocol user-agent string + * @param user_agent user-agent string * * @return * - ESP_OK on success @@ -91,7 +91,7 @@ esp_err_t esp_transport_ws_set_user_agent(esp_transport_handle_t t, const char * * @brief Set websocket additional headers * * @param t websocket transport handle - * @param sub_protocol additional header strings each terminated with \r\n + * @param headers additional header strings each terminated with \r\n * * @return * - ESP_OK on success @@ -103,7 +103,7 @@ esp_err_t esp_transport_ws_set_headers(esp_transport_handle_t t, const char *hea * @brief Set websocket authorization headers * * @param t websocket transport handle - * @param sub_protocol The HTTP authorization header string, set NULL to clear the old value + * @param auth The HTTP authorization header string, set NULL to clear the old value * * @return * - ESP_OK on success