Doc: QByteArrayMatcher: add note that the pattern must remain on scope

This issue bit me. The API is surprising and very un-Qt-like...

Change-Id: I2bbf422288924c198645fffd16aa1c58d921bd7e
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
(cherry picked from commit 7362b321e5cf2053234bb711340cc1603e1ce812)

1 files changed, 6 insertions, 4 deletions

diff --git a/src/corelib/text/qbytearraymatcher.cpp b/src/corelib/text/qbytearraymatcher.cpp
index 4292064de2..9e6d741c88 100644
--- a/src/corelib/text/qbytearraymatcher.cpp
+++ b/src/corelib/text/qbytearraymatcher.cpp
@@ -124,10 +124,12 @@ QByteArrayMatcher::QByteArrayMatcher()
 }
 
 /*!
-  Constructs a byte array matcher from \a pattern. \a pattern
-  has the given \a length. \a pattern must remain in scope, but
-  the destructor does not delete \a pattern.
- */
+    Constructs a byte array matcher from \a pattern. \a pattern
+    has the given \a length. Call indexIn() to perform a search.
+
+    \note the data that \a pattern is referencing must remain valid while this
+    object is used.
+*/
 QByteArrayMatcher::QByteArrayMatcher(const char *pattern, qsizetype length) : d(nullptr)
 {
     p.p = reinterpret_cast<const uchar *>(pattern);