From bc4bd3c1bcaa955d3fea86deef1d8098dfc682d8 Mon Sep 17 00:00:00 2001
From: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
Date: Thu, 15 Oct 2020 01:10:34 +0200
Subject: QESDP::take(): document that it doesn't deref

Change-Id: Iba6c1caf4a7681815559db7c06691d02108ae855
Pick-to: 5.15
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
---
 src/corelib/tools/qshareddata.cpp | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/corelib/tools/qshareddata.cpp b/src/corelib/tools/qshareddata.cpp
index 899a94b65a..42360a4cae 100644
--- a/src/corelib/tools/qshareddata.cpp
+++ b/src/corelib/tools/qshareddata.cpp
@@ -612,7 +612,10 @@ QT_BEGIN_NAMESPACE
     \since 5.12
 
     Returns a pointer to the shared object, and resets \e this to be \nullptr.
-    That is, this function sets the \e{d pointer} of \e this to \nullptr.
+    (That is, this function sets the \e{d pointer} of \e this to \nullptr.)
+
+    \note The reference count of the returned object will \b{not} be
+    decremented.
  */
 
 /*! \fn template <class T> QExplicitlySharedDataPointer<T>::operator bool () const
-- 
cgit v1.2.3