espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-07-29 18:27:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(esp_transport_ws): fix parameter name documentation

Browse Source
This commit is contained in:
Richard Allen
2025-06-12 10:44:06 -05:00
parent adcbdd7da4
commit a8b6017ca5
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
components/tcp_transport/include/esp_transport_ws.h
View File

@ -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