From 64d742443bfacf5b1fad29f44642780b623f9a15 Mon Sep 17 00:00:00 2001 From: lonkaars Date: Sun, 30 Oct 2022 16:52:29 +0100 Subject: add documentation in header files --- shared/protocol.h | 2 ++ shared/util.h | 2 ++ 2 files changed, 4 insertions(+) (limited to 'shared') diff --git a/shared/protocol.h b/shared/protocol.h index 96c039a..e5ddf05 100644 --- a/shared/protocol.h +++ b/shared/protocol.h @@ -148,4 +148,6 @@ static ws_protocol_res_handler_t* g_ws_protocol_res_handlers[WS_PROTOCOL_CMD_AMO [WS_PROTOCOL_CMD_LAST_RECORDS] = &ws_protocol_res_last_records, }; +/** @brief return length of custom protocol header */ unsigned short ws_protocol_get_header_size(ws_s_protocol_res* response); + diff --git a/shared/util.h b/shared/util.h index 94a3dfe..690a999 100644 --- a/shared/util.h +++ b/shared/util.h @@ -3,4 +3,6 @@ #define WS_MIN(a, b) (((a) < (b)) ? (a) : (b)) #define WS_MAX(a, b) (((a) > (b)) ? (a) : (b)) +/** @brief take the log base 16 of `x` */ unsigned int ws_log16(unsigned int x); + -- cgit v1.2.3