From f784705a7ed0ce3fa6be0376b7018a7fdaadd610 Mon Sep 17 00:00:00 2001 From: laz-001 <194351703+laz-001@users.noreply.github.com> Date: Thu, 26 Jun 2025 15:19:28 +0300 Subject: [PATCH] docs: fix missing refs warnings EXTRACT_STATIC flag 2 private methods --- doc/CMakeLists.txt | 1 + doc/dev/protocol_reference.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 0872ba47b..bad3e81e9 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -8,6 +8,7 @@ option(BUILD_DEV_DOCS "Build and install developer documentation" OFF) if (DOXYGEN_FOUND) # Generic Doxygen options set(DOXYGEN_EXTRACT_ALL YES) + set(DOXYGEN_EXTRACT_STATIC YES) set(DOXYGEN_STRIP_FROM_PATH ${CMAKE_SOURCE_DIR}) set(DOXYGEN_QUIET YES) set(DOXYGEN_PROJECT_NAME ${CMAKE_PROJECT_PROPER_NAME}) diff --git a/doc/dev/protocol_reference.md b/doc/dev/protocol_reference.md index f80d3ce62..1908a5b8a 100644 --- a/doc/dev/protocol_reference.md +++ b/doc/dev/protocol_reference.md @@ -228,7 +228,7 @@ When encryption is enabled, the protocol follows this sequence: 3. Protocol handshake begins only after TLS session is established - **Implementation Details**: - - The client initiates a standard TCP connection, then the @ref SecureSocket::handleTCPConnected method is called, which begins the TLS handshake + - The client initiates a standard TCP connection, then the (private) SecureSocket::handleTCPConnected method is called, which begins the TLS handshake - **Certificate Validation**: - Client implementations **must** validate the server's certificate @@ -260,7 +260,7 @@ A modifier (modifier mask) represents the state of modifier keys (like Shift, Co - Upon receiving a kMsgCKeepAlive message, the client must immediately send a kMsgCKeepAlive message back - The client maintains a timeout that is reset each time any message is received - If no message is received for 9.0 seconds (3 × @ref kKeepAliveRate), client must disconnect -- This is handled by the @ref ServerProxy::handleKeepAliveAlarm method +- This is handled by the (private) ServerProxy::handleKeepAliveAlarm method ### Synchronization on Screen Entry