From cf1b300f6a375bff6e4a865034a91ee02c2e6261 Mon Sep 17 00:00:00 2001
From: Ruakij <ruakij@ruekov.eu>
Date: Thu, 25 Nov 2021 03:14:24 +0100
Subject: [PATCH] Changed documentation to remarks section

---
 src/streamHandler/RegexBlockStream.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/streamHandler/RegexBlockStream.js b/src/streamHandler/RegexBlockStream.js
index 62dadfe..8a713c4 100644
--- a/src/streamHandler/RegexBlockStream.js
+++ b/src/streamHandler/RegexBlockStream.js
@@ -10,9 +10,10 @@ class RegexBlockStream extends Transform{
     matchAllOnFlush;
 
     /**
-     * @param {RegExp} matcher Block-match - WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more ressources.
+     * @param {RegExp} matcher Block-match
      * @param {boolean} withholdLastBlock When true, the last matches block will not be submitted to prevent submitting incomplete blocks.
      * @param {boolean} matchAllOnFlush (Only in combination with withholdLastBlock) When enabled, the buffer will be matched on last time on _flush (stream deconstruction) and write any, also incomplete, blocks
+     * @remarks WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more ressources.
      */
     constructor(matcher, withholdLastBlock = true, matchAllOnFlush = false){
         super({