doc: updated comments

This commit is contained in:
aZholtikov committed 2026-08-16 09:13:27 +03:00
1 parent b5b27a1937
commit 03b5d12f1b
2 files changed
+4 -4

No files matched your search

+2 -2
View File
@@ -38,8 +38,8 @@ extern "C"
* the URI path, and registers the HTTP GET (web interface) and HTTP POST * the URI path, and registers the HTTP GET (web interface) and HTTP POST
* (firmware upload) handlers with the provided HTTP server instance. * (firmware upload) handlers with the provided HTTP server instance.
* *
* @param[in] server HTTP server handle obtained from httpd_start(). * @param[in] server HTTP server handle obtained from httpd_start() (must not be NULL)
* @param[in] path URI path for the OTA server (e.g., "/ota"). * @param[in] path URI path for the OTA server (e.g., "/ota")
* *
* @return ESP_OK on success * @return ESP_OK on success
* @return ESP_ERR_INVALID_ARG if invalid server handle or path * @return ESP_ERR_INVALID_ARG if invalid server handle or path
+2 -2
View File
@@ -23,7 +23,7 @@ static char *_ota_ws_path = "/zh_ota_server"; /*!< Fixed URI path for WebSocket-
* *
* Serves the embedded HTML page for firmware upload via HTTP response. * Serves the embedded HTML page for firmware upload via HTTP response.
* *
* @param req HTTP request structure. * @param req HTTP request structure
* *
* @return ESP_OK on success * @return ESP_OK on success
* @return ESP_FAIL if failed to send the response * @return ESP_FAIL if failed to send the response
@@ -37,7 +37,7 @@ static esp_err_t _ota_page_handler(httpd_req_t *req);
* available OTA partition, and activates it as the new boot partition. * available OTA partition, and activates it as the new boot partition.
* The device reboots automatically after a successful update. * The device reboots automatically after a successful update.
* *
* @param req HTTP request containing the firmware binary payload. * @param req HTTP request containing the firmware binary payload
* *
* @return ESP_OK on success * @return ESP_OK on success
* @return ESP_FAIL if OTA operations or HTTP response failed * @return ESP_FAIL if OTA operations or HTTP response failed