From 84be9b069c93afe62082ecd6aa5ec97ce44a8e0f Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Thu, 18 Jul 2024 16:25:53 +0200 Subject: [PATCH] Doc: fix links to QMetaContainer members QMetaContainer was not documented at all, so links from QMetaSequence back to its parent class member functions failed. Add generic class documentation for QMetaContainer. The QMetaAssociation class is also undocumented, but since QMetaContainer's purpose is to provide common APIs for both QMetaSequence and QMetaAssociation, mention it anyway. Fix warnings from incorrectly named parameters in the QMetaContainer API documentation, which now gets generated. Pick-to: 6.8 Change-Id: I50a9f3ebf90b03f049804be2256ff135f57dab14 Reviewed-by: Fabian Kosmale --- src/corelib/kernel/qmetacontainer.cpp | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/src/corelib/kernel/qmetacontainer.cpp b/src/corelib/kernel/qmetacontainer.cpp index 5f68f8fe74d..c70afe163bb 100644 --- a/src/corelib/kernel/qmetacontainer.cpp +++ b/src/corelib/kernel/qmetacontainer.cpp @@ -37,6 +37,18 @@ QT_BEGIN_NAMESPACE Returns the QMetaSequence corresponding to the type given as template parameter. */ +/*! + \class QMetaContainer + \inmodule QtCore + \since 6.0 + \brief The QMetaContainer class provides common functionality for sequential + and associative containers. + + \ingroup objectmodel + + \compares equality +*/ + /*! Returns \c true if the underlying container provides at least an input iterator as defined by std::input_iterator_tag, otherwise returns @@ -492,7 +504,7 @@ void QMetaContainer::copyIterator(void *target, const void *source) const } /*! - Advances the non-const \a iterator by \a step steps. If \a steps is negative + Advances the non-const \a iterator by \a step steps. If \a step is negative the \a iterator is moved backwards, towards the beginning of the container. The behavior is unspecified for negative values of \a step if \l hasBidirectionalIterator() returns false. @@ -740,7 +752,7 @@ void QMetaContainer::copyConstIterator(void *target, const void *source) const } /*! - Advances the const \a iterator by \a step steps. If \a steps is negative + Advances the const \a iterator by \a step steps. If \a step is negative the \a iterator is moved backwards, towards the beginning of the container. The behavior is unspecified for negative values of \a step if \l hasBidirectionalIterator() returns false.