From b99c08dd4ed6c9660e1b2c4d93cb1271e8039e03 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 11 Jan 2022 15:05:44 +0100 Subject: Doc: Use \inmodule for all classes and headers MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit QDoc made some assumptions about the module a class/header belongs to, based on the source file path. This feature is rather error-prone and unnecessarily complex and will be removed from QDoc. Define modules explicitly to avoid documentation warnings when this removal happens. Pick-to: 6.2 6.3 Change-Id: I7947d197db5ac36c12e816caa19bb2f74eda8849 Reviewed-by: Edward Welbourne Reviewed-by: Mårten Nordheim Reviewed-by: Venugopal Shivashankar --- src/corelib/global/qendian.cpp | 1 + src/corelib/global/qglobal.cpp | 1 + src/corelib/itemmodels/qtransposeproxymodel.cpp | 1 + src/corelib/kernel/qiterable.cpp | 2 +- src/corelib/kernel/qmath.qdoc | 1 + src/corelib/plugin/qplugin.qdoc | 1 + src/corelib/serialization/qcborcommon.cpp | 2 +- src/corelib/time/qcalendar.cpp | 1 + src/corelib/tools/qalgorithms.qdoc | 1 + src/corelib/tools/qhash.cpp | 1 + src/gui/accessible/qaccessible.cpp | 2 ++ src/gui/accessible/qaccessibleplugin.cpp | 1 + src/gui/painting/qpageranges.cpp | 1 + src/gui/util/qvalidator.cpp | 1 + src/gui/vulkan/qvulkaninstance.cpp | 3 +++ src/network/kernel/qnetworkinformation.cpp | 1 + src/opengl/qopenglpixeltransferoptions.cpp | 1 + 17 files changed, 20 insertions(+), 2 deletions(-) diff --git a/src/corelib/global/qendian.cpp b/src/corelib/global/qendian.cpp index cc9158e34d..3605fe2c09 100644 --- a/src/corelib/global/qendian.cpp +++ b/src/corelib/global/qendian.cpp @@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE /*! \headerfile + \inmodule QtCore \title Endian Conversion Functions \ingroup funclists \brief The header provides functions to convert between diff --git a/src/corelib/global/qglobal.cpp b/src/corelib/global/qglobal.cpp index a9c44d3237..7bb2fbc6aa 100644 --- a/src/corelib/global/qglobal.cpp +++ b/src/corelib/global/qglobal.cpp @@ -698,6 +698,7 @@ static_assert(sizeof(qint64) == 8, "Internal error, qint64 is misdefined"); /*! \headerfile + \inmodule QtCore \title Global Qt Declarations \ingroup funclists diff --git a/src/corelib/itemmodels/qtransposeproxymodel.cpp b/src/corelib/itemmodels/qtransposeproxymodel.cpp index 558ec45b73..26b2628241 100644 --- a/src/corelib/itemmodels/qtransposeproxymodel.cpp +++ b/src/corelib/itemmodels/qtransposeproxymodel.cpp @@ -170,6 +170,7 @@ void QTransposeProxyModelPrivate::onRowsAboutToBeMoved(const QModelIndex &source /*! \since 5.13 \class QTransposeProxyModel + \inmodule QtCore \brief This proxy transposes the source model. This model will make the rows of the source model become columns of the proxy model and vice-versa. diff --git a/src/corelib/kernel/qiterable.cpp b/src/corelib/kernel/qiterable.cpp index 7ee7be2696..cc3f441517 100644 --- a/src/corelib/kernel/qiterable.cpp +++ b/src/corelib/kernel/qiterable.cpp @@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE /*! \class QBaseIterator - + \inmodule QtCore QBaseIterator forms the common base class for all iterators operating on subclasses of QIterable. */ diff --git a/src/corelib/kernel/qmath.qdoc b/src/corelib/kernel/qmath.qdoc index f8d1f2c0f7..4c07e40765 100644 --- a/src/corelib/kernel/qmath.qdoc +++ b/src/corelib/kernel/qmath.qdoc @@ -27,6 +27,7 @@ /*! \headerfile + \inmodule QtCore \title Generic Math Functions \ingroup funclists diff --git a/src/corelib/plugin/qplugin.qdoc b/src/corelib/plugin/qplugin.qdoc index 968fb4820a..62c3d649d8 100644 --- a/src/corelib/plugin/qplugin.qdoc +++ b/src/corelib/plugin/qplugin.qdoc @@ -27,6 +27,7 @@ /*! \headerfile + \inmodule QtCore \title Defining Plugins \keyword qtplugin-defining-plugins \ingroup plugins diff --git a/src/corelib/serialization/qcborcommon.cpp b/src/corelib/serialization/qcborcommon.cpp index 0ebefe38d7..27ab67d355 100644 --- a/src/corelib/serialization/qcborcommon.cpp +++ b/src/corelib/serialization/qcborcommon.cpp @@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE /*! \headerfile - + \inmodule QtCore \brief The header contains definitions common to both the streaming classes (QCborStreamReader and QCborStreamWriter) and to QCborValue. diff --git a/src/corelib/time/qcalendar.cpp b/src/corelib/time/qcalendar.cpp index 0cf350254e..fe75be3a6a 100644 --- a/src/corelib/time/qcalendar.cpp +++ b/src/corelib/time/qcalendar.cpp @@ -1125,6 +1125,7 @@ const QCalendarBackend *QCalendarBackend::gregorian() /*! \class QCalendar::SystemId + \inmodule QtCore \since 6.2 This is an opaque type used to identify custom calendar implementations. The diff --git a/src/corelib/tools/qalgorithms.qdoc b/src/corelib/tools/qalgorithms.qdoc index 4249cad72e..2814ea3483 100644 --- a/src/corelib/tools/qalgorithms.qdoc +++ b/src/corelib/tools/qalgorithms.qdoc @@ -27,6 +27,7 @@ /*! \headerfile + \inmodule QtCore \title Generic Algorithms \ingroup funclists \keyword generic algorithms diff --git a/src/corelib/tools/qhash.cpp b/src/corelib/tools/qhash.cpp index 64ec33fce9..8f7ffb79b8 100644 --- a/src/corelib/tools/qhash.cpp +++ b/src/corelib/tools/qhash.cpp @@ -832,6 +832,7 @@ size_t qHash(QLatin1String key, size_t seed) noexcept /*! \class QHashSeed + \inmodule QtCore \since 6.2 The QHashSeed class is used to convey the QHash seed. This is used diff --git a/src/gui/accessible/qaccessible.cpp b/src/gui/accessible/qaccessible.cpp index 2fdcbfdd27..0d258ccd78 100644 --- a/src/gui/accessible/qaccessible.cpp +++ b/src/gui/accessible/qaccessible.cpp @@ -2516,6 +2516,7 @@ QAccessibleTableCellInterface::~QAccessibleTableCellInterface() /*! \class QAccessibleTableInterface + \inmodule QtGui \ingroup accessibility \brief The QAccessibleTableInterface class implements support for @@ -2662,6 +2663,7 @@ QAccessibleTableInterface::~QAccessibleTableInterface() /*! \class QAccessibleActionInterface + \inmodule QtGui \ingroup accessibility \brief The QAccessibleActionInterface class implements support for diff --git a/src/gui/accessible/qaccessibleplugin.cpp b/src/gui/accessible/qaccessibleplugin.cpp index 27497858b5..460d2d179a 100644 --- a/src/gui/accessible/qaccessibleplugin.cpp +++ b/src/gui/accessible/qaccessibleplugin.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE /*! \class QAccessiblePlugin + \inmodule QtGui \brief The QAccessiblePlugin class provides an abstract base class for plugins provinding accessibility information for user interface elements. diff --git a/src/gui/painting/qpageranges.cpp b/src/gui/painting/qpageranges.cpp index dc43143d9c..2970037691 100644 --- a/src/gui/painting/qpageranges.cpp +++ b/src/gui/painting/qpageranges.cpp @@ -374,6 +374,7 @@ QDebug operator<<(QDebug dbg, const QPageRanges &pageRanges) /*! \struct QPageRanges::Range + \inmodule QtGui \brief The QPageRanges::Range struct holds the \c from and \c to endpoints of a range. \sa QPageRanges::toRangeList() diff --git a/src/gui/util/qvalidator.cpp b/src/gui/util/qvalidator.cpp index 14d9c01503..00e52f31e4 100644 --- a/src/gui/util/qvalidator.cpp +++ b/src/gui/util/qvalidator.cpp @@ -915,6 +915,7 @@ QDoubleValidator::Notation QDoubleValidator::notation() const /*! \class QRegularExpressionValidator + \inmodule QtGui \brief The QRegularExpressionValidator class is used to check a string against a regular expression. diff --git a/src/gui/vulkan/qvulkaninstance.cpp b/src/gui/vulkan/qvulkaninstance.cpp index fc4a916cb4..aaa8691273 100644 --- a/src/gui/vulkan/qvulkaninstance.cpp +++ b/src/gui/vulkan/qvulkaninstance.cpp @@ -315,6 +315,7 @@ QVulkanInstance::~QVulkanInstance() /*! \class QVulkanLayer + \inmodule QtGui \brief Represents information about a Vulkan layer. */ @@ -368,6 +369,7 @@ QVulkanInstance::~QVulkanInstance() /*! \class QVulkanExtension + \inmodule QtGui \brief Represents information about a Vulkan extension. */ @@ -411,6 +413,7 @@ QVulkanInstance::~QVulkanInstance() /*! \class QVulkanInfoVector + \inmodule QtGui \brief A specialized QList for QVulkanLayer and QVulkanExtension. */ diff --git a/src/network/kernel/qnetworkinformation.cpp b/src/network/kernel/qnetworkinformation.cpp index 89fbf1ca08..a9a875ec1a 100644 --- a/src/network/kernel/qnetworkinformation.cpp +++ b/src/network/kernel/qnetworkinformation.cpp @@ -417,6 +417,7 @@ QNetworkInformationBackendFactory::~QNetworkInformationBackendFactory() /*! \class QNetworkInformation + \inmodule QtNetwork \since 6.1 \brief QNetworkInformation exposes various network information through native backends. diff --git a/src/opengl/qopenglpixeltransferoptions.cpp b/src/opengl/qopenglpixeltransferoptions.cpp index aa1af3b092..6841307a07 100644 --- a/src/opengl/qopenglpixeltransferoptions.cpp +++ b/src/opengl/qopenglpixeltransferoptions.cpp @@ -44,6 +44,7 @@ QT_BEGIN_NAMESPACE /*! * \class QOpenGLPixelTransferOptions + * \inmodule QtOpenGL * * \brief The QOpenGLPixelTransferOptions class describes the pixel storage * modes that affect the unpacking of pixels during texture upload. -- cgit v1.2.3