Doc: Use \inmodule for all classes and headers

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 <edward.welbourne@qt.io>
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
This commit is contained in:
Topi Reinio 2022-01-11 15:05:44 +01:00 committed by Topi Reiniö
parent 8c4dee6f97
commit b99c08dd4e
17 changed files with 20 additions and 2 deletions

View File

@ -47,6 +47,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\headerfile <QtEndian> \headerfile <QtEndian>
\inmodule QtCore
\title Endian Conversion Functions \title Endian Conversion Functions
\ingroup funclists \ingroup funclists
\brief The <QtEndian> header provides functions to convert between \brief The <QtEndian> header provides functions to convert between

View File

@ -698,6 +698,7 @@ static_assert(sizeof(qint64) == 8, "Internal error, qint64 is misdefined");
/*! /*!
\headerfile <QtGlobal> \headerfile <QtGlobal>
\inmodule QtCore
\title Global Qt Declarations \title Global Qt Declarations
\ingroup funclists \ingroup funclists

View File

@ -170,6 +170,7 @@ void QTransposeProxyModelPrivate::onRowsAboutToBeMoved(const QModelIndex &source
/*! /*!
\since 5.13 \since 5.13
\class QTransposeProxyModel \class QTransposeProxyModel
\inmodule QtCore
\brief This proxy transposes the source model. \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. This model will make the rows of the source model become columns of the proxy model and vice-versa.

View File

@ -43,7 +43,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QBaseIterator \class QBaseIterator
\inmodule QtCore
QBaseIterator forms the common base class for all iterators operating on QBaseIterator forms the common base class for all iterators operating on
subclasses of QIterable. subclasses of QIterable.
*/ */

View File

@ -27,6 +27,7 @@
/*! /*!
\headerfile <QtMath> \headerfile <QtMath>
\inmodule QtCore
\title Generic Math Functions \title Generic Math Functions
\ingroup funclists \ingroup funclists

View File

@ -27,6 +27,7 @@
/*! /*!
\headerfile <QtPlugin> \headerfile <QtPlugin>
\inmodule QtCore
\title Defining Plugins \title Defining Plugins
\keyword qtplugin-defining-plugins \keyword qtplugin-defining-plugins
\ingroup plugins \ingroup plugins

View File

@ -50,7 +50,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\headerfile <QtCborCommon> \headerfile <QtCborCommon>
\inmodule QtCore
\brief The <QtCborCommon> header contains definitions common to both the \brief The <QtCborCommon> header contains definitions common to both the
streaming classes (QCborStreamReader and QCborStreamWriter) and to streaming classes (QCborStreamReader and QCborStreamWriter) and to
QCborValue. QCborValue.

View File

@ -1125,6 +1125,7 @@ const QCalendarBackend *QCalendarBackend::gregorian()
/*! /*!
\class QCalendar::SystemId \class QCalendar::SystemId
\inmodule QtCore
\since 6.2 \since 6.2
This is an opaque type used to identify custom calendar implementations. The This is an opaque type used to identify custom calendar implementations. The

View File

@ -27,6 +27,7 @@
/*! /*!
\headerfile <QtAlgorithms> \headerfile <QtAlgorithms>
\inmodule QtCore
\title Generic Algorithms \title Generic Algorithms
\ingroup funclists \ingroup funclists
\keyword generic algorithms \keyword generic algorithms

View File

@ -832,6 +832,7 @@ size_t qHash(QLatin1String key, size_t seed) noexcept
/*! /*!
\class QHashSeed \class QHashSeed
\inmodule QtCore
\since 6.2 \since 6.2
The QHashSeed class is used to convey the QHash seed. This is used The QHashSeed class is used to convey the QHash seed. This is used

View File

@ -2516,6 +2516,7 @@ QAccessibleTableCellInterface::~QAccessibleTableCellInterface()
/*! /*!
\class QAccessibleTableInterface \class QAccessibleTableInterface
\inmodule QtGui
\ingroup accessibility \ingroup accessibility
\brief The QAccessibleTableInterface class implements support for \brief The QAccessibleTableInterface class implements support for
@ -2662,6 +2663,7 @@ QAccessibleTableInterface::~QAccessibleTableInterface()
/*! /*!
\class QAccessibleActionInterface \class QAccessibleActionInterface
\inmodule QtGui
\ingroup accessibility \ingroup accessibility
\brief The QAccessibleActionInterface class implements support for \brief The QAccessibleActionInterface class implements support for

View File

@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
\class QAccessiblePlugin \class QAccessiblePlugin
\inmodule QtGui
\brief The QAccessiblePlugin class provides an abstract base class \brief The QAccessiblePlugin class provides an abstract base class
for plugins provinding accessibility information for user interface elements. for plugins provinding accessibility information for user interface elements.

View File

@ -374,6 +374,7 @@ QDebug operator<<(QDebug dbg, const QPageRanges &pageRanges)
/*! /*!
\struct QPageRanges::Range \struct QPageRanges::Range
\inmodule QtGui
\brief The QPageRanges::Range struct holds the \c from and \c to endpoints of a range. \brief The QPageRanges::Range struct holds the \c from and \c to endpoints of a range.
\sa QPageRanges::toRangeList() \sa QPageRanges::toRangeList()

View File

@ -915,6 +915,7 @@ QDoubleValidator::Notation QDoubleValidator::notation() const
/*! /*!
\class QRegularExpressionValidator \class QRegularExpressionValidator
\inmodule QtGui
\brief The QRegularExpressionValidator class is used to check a string \brief The QRegularExpressionValidator class is used to check a string
against a regular expression. against a regular expression.

View File

@ -315,6 +315,7 @@ QVulkanInstance::~QVulkanInstance()
/*! /*!
\class QVulkanLayer \class QVulkanLayer
\inmodule QtGui
\brief Represents information about a Vulkan layer. \brief Represents information about a Vulkan layer.
*/ */
@ -368,6 +369,7 @@ QVulkanInstance::~QVulkanInstance()
/*! /*!
\class QVulkanExtension \class QVulkanExtension
\inmodule QtGui
\brief Represents information about a Vulkan extension. \brief Represents information about a Vulkan extension.
*/ */
@ -411,6 +413,7 @@ QVulkanInstance::~QVulkanInstance()
/*! /*!
\class QVulkanInfoVector \class QVulkanInfoVector
\inmodule QtGui
\brief A specialized QList for QVulkanLayer and QVulkanExtension. \brief A specialized QList for QVulkanLayer and QVulkanExtension.
*/ */

View File

@ -417,6 +417,7 @@ QNetworkInformationBackendFactory::~QNetworkInformationBackendFactory()
/*! /*!
\class QNetworkInformation \class QNetworkInformation
\inmodule QtNetwork
\since 6.1 \since 6.1
\brief QNetworkInformation exposes various network information \brief QNetworkInformation exposes various network information
through native backends. through native backends.

View File

@ -44,6 +44,7 @@ QT_BEGIN_NAMESPACE
/*! /*!
* \class QOpenGLPixelTransferOptions * \class QOpenGLPixelTransferOptions
* \inmodule QtOpenGL
* *
* \brief The QOpenGLPixelTransferOptions class describes the pixel storage * \brief The QOpenGLPixelTransferOptions class describes the pixel storage
* modes that affect the unpacking of pixels during texture upload. * modes that affect the unpacking of pixels during texture upload.