1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: fix links to QMetaContainer members

Browse Source 
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.

Change-Id: I50a9f3ebf90b03f049804be2256ff135f57dab14
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
(cherry picked from commit 84be9b069c93afe62082ecd6aa5ec97ce44a8e0f)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
This commit is contained in:
Volker Hilsheimer 2024-07-18 16:25:53 +02:00 committed by Qt Cherry-pick Bot
parent 091d732b15
commit aabaf64c25
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/corelib/kernel/qmetacontainer.cpp
View File

@ -37,6 +37,18 @@ QT_BEGIN_NAMESPACE
Returns the QMetaSequence corresponding to the type given as template parameter. 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 Returns \c true if the underlying container provides at least an input
iterator as defined by std::input_iterator_tag, otherwise returns 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 \a iterator is moved backwards, towards the beginning of the container.
The behavior is unspecified for negative values of \a step if The behavior is unspecified for negative values of \a step if
\l hasBidirectionalIterator() returns false. \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 \a iterator is moved backwards, towards the beginning of the container.
The behavior is unspecified for negative values of \a step if The behavior is unspecified for negative values of \a step if
\l hasBidirectionalIterator() returns false. \l hasBidirectionalIterator() returns false.