feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

Merge branch 'bugfix/http_ws_api_reference' into 'master'

Browse Source 
fix(esp_http_server): enable doxygen build for websocket API reference

Closes IDFGH-14785

See merge request espressif/esp-idf!37529
This commit is contained in:
Mahavir Jain
2025-03-11 19:12:36 +08:00
parent 2f538ffbb2 4b6c5f34cd
commit 884c85536d
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
components/esp_http_server/include/esp_http_server.h
View File

@@ -441,7 +441,7 @@ typedef struct httpd_uri {
*/
void *user_ctx;
#ifdef CONFIG_HTTPD_WS_SUPPORT
#if CONFIG_HTTPD_WS_SUPPORT || __DOXYGEN__
/**
* Flag for indicating a WebSocket endpoint.
* If this flag is true, then method must be HTTP_GET. Otherwise the handshake will not be handled.
@@ -1673,7 +1673,7 @@ esp_err_t httpd_queue_work(httpd_handle_t handle, httpd_work_fn_t work, void *ar
* Functions and structs for WebSocket server
* @{
*/
#ifdef CONFIG_HTTPD_WS_SUPPORT
#if CONFIG_HTTPD_WS_SUPPORT || __DOXYGEN__
/**
* @brief Enum for WebSocket packet types (Opcode in the header)
* @note Please refer to RFC6455 Section 5.4 for more details
@@ -1808,7 +1808,7 @@ esp_err_t httpd_ws_send_data(httpd_handle_t handle, int socket, httpd_ws_frame_t
esp_err_t httpd_ws_send_data_async(httpd_handle_t handle, int socket, httpd_ws_frame_t *frame,
transfer_complete_cb callback, void *arg);
#endif /* CONFIG_HTTPD_WS_SUPPORT */
#endif /* CONFIG_HTTPD_WS_SUPPORT || __DOXYGEN__ */
/** End of WebSocket related stuff
* @}
*/