enhance Telegram Buffer doc

w0lek · w0lek · commit 56d8abc2f638 · 2024-06-07T17:33:48.000+03:00
diff --git a/vpr/src/server/telegrambuffer.h b/vpr/src/server/telegrambuffer.h
@@ -16,7 +16,7 @@ namespace comm {
 /** 
  * @brief Implements Telegram Buffer as a wrapper over BytesArray
  * 
- * It aggregates received bytes and return only well filled frames.
+ * It aggregates received bytes and assists in extracting telegram frames ( @ref TelegramFrame ) from the raw byte buffer.
 */
 class TelegramBuffer
 {

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ namespace comm {`
`16`	`16`	`/**`
`17`	`17`	`* @brief Implements Telegram Buffer as a wrapper over BytesArray`
`18`	`18`	`*`
`19`		`- * It aggregates received bytes and return only well filled frames.`
	`19`	`+ * It aggregates received bytes and assists in extracting telegram frames ( @ref TelegramFrame ) from the raw byte buffer.`
`20`	`20`	`*/`
`21`	`21`	`class TelegramBuffer`
`22`	`22`	`{`