diff options
| author | lonkaars <loek@pipeframe.xyz> | 2022-10-30 16:52:29 +0100 |
|---|---|---|
| committer | lonkaars <loek@pipeframe.xyz> | 2022-10-30 16:52:29 +0100 |
| commit | 64d742443bfacf5b1fad29f44642780b623f9a15 (patch) | |
| tree | 176f2f65cdbfb13a4236e7964e21cb62e2d1e6c3 /shared | |
| parent | 0c8e3c7e6cdc99a14b38edd747d07d7b03fb294c (diff) | |
add documentation in header files
Diffstat (limited to 'shared')
| -rw-r--r-- | shared/protocol.h | 2 | ||||
| -rw-r--r-- | shared/util.h | 2 |
2 files changed, 4 insertions, 0 deletions
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); + |