From 6419dd972dcbce88bc71ca1593b5ba90ad789fb6 Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Sun, 25 Oct 2020 15:37:12 +0100 Subject: [PATCH] Document QVariant::data/constData QMetaSequence refers to those members, and QMetaType operates on void*s, and documents such low-level APIs as well, so can't think of a reason why we should not document the QVariant getters as well. Change-Id: Id18de839bb0e4f5559b28bfca80eaabab1eb6479 Reviewed-by: Lars Knoll --- src/corelib/kernel/qvariant.cpp | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/corelib/kernel/qvariant.cpp b/src/corelib/kernel/qvariant.cpp index f2e2ae2c2e..8d4bb38dc6 100644 --- a/src/corelib/kernel/qvariant.cpp +++ b/src/corelib/kernel/qvariant.cpp @@ -2391,11 +2391,21 @@ std::optional QVariant::compare(const QVariant &lhs, const QVariant &rhs) /*! \fn const void *QVariant::constData() const \fn const void* QVariant::data() const - \internal + + Returns a pointer to the contained object as a generic void* that cannot be + written to. + + \sa QMetaType */ /*! - \internal + Returns a pointer to the contained object as a generic void* that can be + written to. + + This function detaches the QVariant. When called on a \l{isNull}{null-QVariant}, + the QVariant will not be null after the call. + + \sa QMetaType */ void *QVariant::data() {