From 9438da35ab925a4131620829ae2fa93db3f56c08 Mon Sep 17 00:00:00 2001
From: Olivier Goffart <ogoffart@woboq.com>
Date: Sun, 10 Aug 2014 20:02:12 +0200
Subject: Document that some types need not to be registered with
 Q_DECLARE_METATYPE
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: I2f9b119ebe72595620ec40c2c9b95b0a9defa848
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@theqtcompany.com>
Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
---
 src/corelib/kernel/qmetatype.cpp | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'src/corelib')

diff --git a/src/corelib/kernel/qmetatype.cpp b/src/corelib/kernel/qmetatype.cpp
index 9df4649ae8..4b441999a1 100644
--- a/src/corelib/kernel/qmetatype.cpp
+++ b/src/corelib/kernel/qmetatype.cpp
@@ -131,6 +131,19 @@ struct DefinedTypesFilter {
 
     \snippet code/src_corelib_kernel_qmetatype.cpp 2
 
+    Some types are registered automatically and do not need this macro:
+
+    \list
+    \li Pointers to classes derived from QObject
+    \li QList<T>, QVector<T>, QQueue<T>, QStack<T>, QSet<T> or QLinkedList<T>
+        where T is a registered meta type
+    \li QHash<T1, T2>, QMap<T1, T2> or QPair<T1, T2> where T1 and T2 are
+        registered meta types
+    \li QPointer<T>, QSharedPointer<T>, QWeakPointer<T>, where T is a class that derives from QObject
+    \li Enumerations registered with Q_ENUM or Q_FLAG
+    \li Classes that have a Q_GADGET macro
+    \endlist
+
     \sa qRegisterMetaType()
 */
 
-- 
cgit v1.2.3