From 3a26e70e8ae8541e6f7bf0f0c86063fbaa6d01cf Mon Sep 17 00:00:00 2001
From: Fabian Kosmale <fabian.kosmale@qt.io>
Date: Tue, 2 Nov 2021 14:54:25 +0100
Subject: QBiPointer: Add internal documentation

Change-Id: I9269ca95694866dde1389ff3e5396d6a94eaa386
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Reviewed-by: Andrei Golubev <andrei.golubev@qt.io>
---
 src/qml/qml/ftw/qflagpointer_p.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/src/qml/qml/ftw/qflagpointer_p.h b/src/qml/qml/ftw/qflagpointer_p.h
index c8824f3866..3d1de3c136 100644
--- a/src/qml/qml/ftw/qflagpointer_p.h
+++ b/src/qml/qml/ftw/qflagpointer_p.h
@@ -66,6 +66,16 @@ template <> struct QFlagPointerAlignment<void>
 };
 }
 
+/*!
+    \internal
+    \class template<typename T1, typename T2> QBiPointer<T1, T2>
+
+    \short QBiPointer can be thought of as a space-optimized std::variant<T1*, T2*>
+    with a nicer API to check the active pointer. Its other main feature is that
+    it only requires sizeof(void *) space.
+
+    \note It can also store one additional flag for a user defined purpose.
+ */
 template<typename T, typename T2>
 class QBiPointer {
 public:
-- 
cgit v1.2.3