From c445d93a14b06bfc1feedfe9fc949803a26cca8a Mon Sep 17 00:00:00 2001
From: Oleksandr <apivovarov@quicklogic.com>
Date: Fri, 7 Jun 2024 16:53:46 +0300
Subject: [PATCH] add doc for TelegramBuffer::check_telegram_header_presence

---
 vpr/src/server/telegrambuffer.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/vpr/src/server/telegrambuffer.h b/vpr/src/server/telegrambuffer.h
index 449e7f4fbfd..2300303e387 100644
--- a/vpr/src/server/telegrambuffer.h
+++ b/vpr/src/server/telegrambuffer.h
@@ -89,6 +89,15 @@ class TelegramBuffer
     std::vector<std::string> m_errors;
     std::optional<TelegramHeader> m_header_opt;
 
+    /**
+     * @brief Checks for the presence of the telegram header in the buffer.
+     *
+     * This function searches for the telegram header signature in the raw buffer.
+     * If the signature is found, any bytes preceding the header start position
+     * are discarded from the buffer.
+     *
+     * @return true if the telegram header signature is found, false otherwise.
+     */
     bool check_telegram_header_presence();
 };