From ec1057a05af4e0c29caae0247fcab5622a90ef33 Mon Sep 17 00:00:00 2001 From: Vikram Dattu Date: Mon, 27 Nov 2023 11:57:55 +0530 Subject: [PATCH] fix(esp_srp): Use `@file` for file documentation and missing doc Using @brief for file description wrongly associates the documentation to an API. Correct way to add file description is to use `@file` and then `@brief`. Corrected the same. - Also added missing doc for esp_srp_handle_t --- components/protocomm/include/crypto/srp6a/esp_srp.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/components/protocomm/include/crypto/srp6a/esp_srp.h b/components/protocomm/include/crypto/srp6a/esp_srp.h index 23db7db35c..b02d78a5b5 100644 --- a/components/protocomm/include/crypto/srp6a/esp_srp.h +++ b/components/protocomm/include/crypto/srp6a/esp_srp.h @@ -13,6 +13,7 @@ extern "C" { #endif /** + * @file esp_srp.h * @brief SRP-6a protocol implementation * * More information on protocol can be found: https://datatracker.ietf.org/doc/html/rfc5054 @@ -98,6 +99,13 @@ typedef enum { ESP_NG_3072 = 0, } esp_ng_type_t; +/** + * @brief esp_srp handle as the result of `esp_srp_init` + * + * The handle is returned by `esp_srp_init` on successful init. It is then + * passed for subsequent API calls as an argument. `esp_srp_free` can be used to + * clean up the handle. After `esp_srp_free` the handle becomes invalid. + */ typedef struct esp_srp_handle esp_srp_handle_t; /**