From 03b5d12f1b6dbc260cb493c253943fcf718e10ce Mon Sep 17 00:00:00 2001 From: Alexey Zholtikov Date: Sun, 16 Aug 2026 09:13:27 +0300 Subject: [PATCH] doc: updated comments --- include/zh_ota_server.h | 4 ++-- zh_ota_server.c | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/include/zh_ota_server.h b/include/zh_ota_server.h index 6e6760b..fb58253 100644 --- a/include/zh_ota_server.h +++ b/include/zh_ota_server.h @@ -38,8 +38,8 @@ extern "C" * the URI path, and registers the HTTP GET (web interface) and HTTP POST * (firmware upload) handlers with the provided HTTP server instance. * - * @param[in] server HTTP server handle obtained from httpd_start(). - * @param[in] path URI path for the OTA server (e.g., "/ota"). + * @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") * * @return ESP_OK on success * @return ESP_ERR_INVALID_ARG if invalid server handle or path diff --git a/zh_ota_server.c b/zh_ota_server.c index 6e711dc..4181171 100644 --- a/zh_ota_server.c +++ b/zh_ota_server.c @@ -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. * - * @param req HTTP request structure. + * @param req HTTP request structure * * @return ESP_OK on success * @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. * 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_FAIL if OTA operations or HTTP response failed