From 99abdd180bd6f626f4ca94806fdaddbeb3774325 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Thu, 19 Nov 2020 13:45:37 +0100 Subject: Doc: Fix various documentation warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - QList iterators are now nested classes inside QList. - Drop reference to Qt OpenGL Widgets landing page, there is no such page. - Fix typos and linking issues. Fixes: QTBUG-86295 Pick-to: 6.0 Change-Id: I964843deb81aa55ff8ddb9a1c2b004cb72e68de9 Reviewed-by: Topi Reiniö Reviewed-by: Paul Wicking --- src/corelib/kernel/qobject.cpp | 2 +- src/corelib/tools/qlist.qdoc | 14 ++++++-------- src/corelib/tools/qvarlengtharray.qdoc | 4 ++-- src/opengl/doc/src/qtopengl-module.qdoc | 3 --- src/widgets/doc/src/qtwidgets.qdoc | 2 +- 5 files changed, 10 insertions(+), 15 deletions(-) (limited to 'src') diff --git a/src/corelib/kernel/qobject.cpp b/src/corelib/kernel/qobject.cpp index 54bed0564f..a3bc0ac040 100644 --- a/src/corelib/kernel/qobject.cpp +++ b/src/corelib/kernel/qobject.cpp @@ -4224,7 +4224,7 @@ QDebug operator<<(QDebug dbg, const QObject *o) This macro associates extra information to the class, which is available using QObject::metaObject(). Qt makes only limited use of this feature in - \l{Qt D-Bus} and \l{Qt QML module}{Qt QML}. + \l{Qt D-Bus} and \l{Qt QML} modules. The extra information takes the form of a \a Name string and a \a Value literal string. diff --git a/src/corelib/tools/qlist.qdoc b/src/corelib/tools/qlist.qdoc index 33046f8a2f..4f78f75dc0 100644 --- a/src/corelib/tools/qlist.qdoc +++ b/src/corelib/tools/qlist.qdoc @@ -1381,10 +1381,9 @@ \overload */ -/*! \typedef QList::iterator - - The QList::iterator typedef provides an STL-style non-const - iterator for QList and QStack. +/*! \class QList::iterator + \inmodule QtCore + \brief Provides an STL-style non-const iterator for QList and QStack. QList provides both \l{STL-style iterators} and \l{Java-style iterators}. @@ -1403,10 +1402,9 @@ \sa QList::begin(), QList::end(), QList::const_iterator, QMutableListIterator */ -/*! \typedef QList::const_iterator - - The QList::const_iterator typedef provides an STL-style const - iterator for QList and QStack. +/*! \class QList::const_iterator + \inmodule QtCore + \brief Provides an STL-style const iterator for QList and QStack. QList provides both \l{STL-style iterators} and \l{Java-style iterators}. diff --git a/src/corelib/tools/qvarlengtharray.qdoc b/src/corelib/tools/qvarlengtharray.qdoc index e454276f9d..e1abebc3f9 100644 --- a/src/corelib/tools/qvarlengtharray.qdoc +++ b/src/corelib/tools/qvarlengtharray.qdoc @@ -775,7 +775,7 @@ This function requires the value type to have an implementation of \c operator==(). - \sa operator!=() + \sa {operator!=(const QVarLengthArray &left, const QVarLengthArray &right)}{operator!=()} */ /*! \fn template bool operator!=(const QVarLengthArray &left, const QVarLengthArray &right) @@ -790,7 +790,7 @@ This function requires the value type to have an implementation of \c operator==(). - \sa operator==() + \sa {operator==(const QVarLengthArray &left, const QVarLengthArray &right)}{operator==()} */ /*! \fn template bool operator<(const QVarLengthArray &lhs, const QVarLengthArray &rhs) diff --git a/src/opengl/doc/src/qtopengl-module.qdoc b/src/opengl/doc/src/qtopengl-module.qdoc index 7bf0c18f93..3659ae7843 100644 --- a/src/opengl/doc/src/qtopengl-module.qdoc +++ b/src/opengl/doc/src/qtopengl-module.qdoc @@ -52,7 +52,4 @@ \title Qt OpenGL Widgets C++ Classes \qtcmakepackage OpenGLWidgets \qtvariable openglwidgets - - The \l{Qt OpenGL Widgets} page contains information about how to use the - module. */ diff --git a/src/widgets/doc/src/qtwidgets.qdoc b/src/widgets/doc/src/qtwidgets.qdoc index 302963c771..ca6e7c129e 100644 --- a/src/widgets/doc/src/qtwidgets.qdoc +++ b/src/widgets/doc/src/qtwidgets.qdoc @@ -34,6 +34,6 @@ \brief The Qt Widgets module extends Qt GUI with C++ widget functionality. - The \l{Qt Widget} page contains information about how to use the module. + The \l{Qt Widgets} page contains information about how to use the module. */ -- cgit v1.2.3