diff options
author | Topi Reinio <topi.reinio@qt.io> | 2023-09-06 13:05:41 +0000 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2023-10-09 17:24:07 +0000 |
commit | dc33b0ca7a680713552063d7f74befea53f34814 (patch) | |
tree | 69da353f5351c0f5b8c03f3e700242b80e7bdd18 | |
parent | 64e1744a579b50a19cda2433094a4fc9b8ed61ba (diff) |
Doc: Fix warnings and linking issues
Remove or replace links to examples that were removed or moved under
manual tests.
Replace code snippets that were quoting the now-missing examples.
Fix documentation of QSet::removeIf().
Fix typo in documentation macro: Unknown command '\examplecateogry'.
Add qtopengl, qtshadertools dependencies to Qt Widgets documentation
project to enable correct linking to those topics.
Mark all documentation sets in qtbase as free of warnings.
Pick-to: 6.6 6.5
Change-Id: I058cd5f2063aa933ea310bceff906f05422a7cb2
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r-- | src/concurrent/doc/qtconcurrent.qdocconf | 3 | ||||
-rw-r--r-- | src/corelib/doc/qtcore.qdocconf | 3 | ||||
-rw-r--r-- | src/corelib/doc/src/resource-system.qdoc | 3 | ||||
-rw-r--r-- | src/corelib/doc/src/timers.qdoc | 3 | ||||
-rw-r--r-- | src/corelib/global/qnamespace.qdoc | 3 | ||||
-rw-r--r-- | src/corelib/io/qsettings.cpp | 3 | ||||
-rw-r--r-- | src/corelib/itemmodels/qabstractitemmodel.cpp | 8 | ||||
-rw-r--r-- | src/corelib/kernel/qbasictimer.cpp | 3 | ||||
-rw-r--r-- | src/corelib/plugin/qpluginloader.cpp | 2 | ||||
-rw-r--r-- | src/corelib/tools/qset.qdoc | 8 | ||||
-rw-r--r-- | src/dbus/doc/qtdbus.qdocconf | 3 | ||||
-rw-r--r-- | src/gui/doc/qtgui.qdocconf | 3 | ||||
-rw-r--r-- | src/gui/doc/src/dnd.qdoc | 6 | ||||
-rw-r--r-- | src/gui/image/qicon.cpp | 4 | ||||
-rw-r--r-- | src/network/doc/qtnetwork.qdocconf | 3 | ||||
-rw-r--r-- | src/opengl/doc/qtopengl.qdocconf | 3 | ||||
-rw-r--r-- | src/printsupport/doc/qtprintsupport.qdocconf | 3 | ||||
-rw-r--r-- | src/sql/doc/qtsql.qdocconf | 3 | ||||
-rw-r--r-- | src/testlib/doc/qttestlib.qdocconf | 3 | ||||
-rw-r--r-- | src/widgets/doc/qtwidgets.qdocconf | 18 | ||||
-rw-r--r-- | src/xml/doc/qtxml.qdocconf | 3 |
21 files changed, 65 insertions, 26 deletions
diff --git a/src/concurrent/doc/qtconcurrent.qdocconf b/src/concurrent/doc/qtconcurrent.qdocconf index d83742f15d..c4efe64d0a 100644 --- a/src/concurrent/doc/qtconcurrent.qdocconf +++ b/src/concurrent/doc/qtconcurrent.qdocconf @@ -42,3 +42,6 @@ imagedirs += images navigation.landingpage = "Qt Concurrent" navigation.cppclassespage = "Qt Concurrent C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/corelib/doc/qtcore.qdocconf b/src/corelib/doc/qtcore.qdocconf index e97aa07e72..7076428244 100644 --- a/src/corelib/doc/qtcore.qdocconf +++ b/src/corelib/doc/qtcore.qdocconf @@ -59,3 +59,6 @@ excludefiles += ../kernel/qtestsupport_core.cpp navigation.landingpage = "Qt Core" navigation.cppclassespage = "Qt Core C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/corelib/doc/src/resource-system.qdoc b/src/corelib/doc/src/resource-system.qdoc index 8324ae29f6..7c7613c9b8 100644 --- a/src/corelib/doc/src/resource-system.qdoc +++ b/src/corelib/doc/src/resource-system.qdoc @@ -130,9 +130,6 @@ \snippet resource-system/main.cpp url - See the \l{mainwindows/mainwindow}{Mainwindow} example for an actual - application that uses Qt's resource system to store its icons. - \section1 Advanced Topics \section2 Prefixes diff --git a/src/corelib/doc/src/timers.qdoc b/src/corelib/doc/src/timers.qdoc index 1d5a48af3d..e13baa6eec 100644 --- a/src/corelib/doc/src/timers.qdoc +++ b/src/corelib/doc/src/timers.qdoc @@ -94,6 +94,5 @@ optimization, you can use QBasicTimer instead of QTimer. With QBasicTimer, you must reimplement \l{QObject::timerEvent()}{timerEvent()} in your QObject subclass - and handle the timeout there. The \l{widgets/tetrix}{Tetrix} - example shows how to use QBasicTimer. + and handle the timeout there. */ diff --git a/src/corelib/global/qnamespace.qdoc b/src/corelib/global/qnamespace.qdoc index d3dc181903..712ef53e5c 100644 --- a/src/corelib/global/qnamespace.qdoc +++ b/src/corelib/global/qnamespace.qdoc @@ -980,8 +980,7 @@ \value WA_Hover Forces Qt to generate paint events when the mouse enters or leaves the widget. This feature is typically used when - implementing custom styles; see the \l{widgets/styles}{Styles} - example for details. + implementing custom styles. \value WA_InputMethodEnabled Enables input methods for Asian languages. Must be set when creating custom text editing widgets. diff --git a/src/corelib/io/qsettings.cpp b/src/corelib/io/qsettings.cpp index 6cc0fb3f70..c17999aea5 100644 --- a/src/corelib/io/qsettings.cpp +++ b/src/corelib/io/qsettings.cpp @@ -2150,9 +2150,6 @@ void QConfFileSettingsPrivate::ensureSectionParsed(QConfFile *confFile, \codeline \snippet settings/settings.cpp 21 - See the \l{mainwindows/application}{Application} example for a - self-contained example that uses QSettings. - \section1 Accessing Settings from Multiple Threads or Processes Simultaneously QSettings is \l{reentrant}. This means that you can use diff --git a/src/corelib/itemmodels/qabstractitemmodel.cpp b/src/corelib/itemmodels/qabstractitemmodel.cpp index e4f453b4c1..6577cbcea2 100644 --- a/src/corelib/itemmodels/qabstractitemmodel.cpp +++ b/src/corelib/itemmodels/qabstractitemmodel.cpp @@ -1743,7 +1743,13 @@ QAbstractItemModel::~QAbstractItemModel() For example: - \snippet ../widgets/itemviews/simpledommodel/dommodel.cpp 2 + \code + int MyModel::columnCount(const QModelIndex &parent) const + { + Q_UNUSED(parent); + return 3; + } + \endcode \note When implementing a table based model, columnCount() should return 0 when the parent is valid. diff --git a/src/corelib/kernel/qbasictimer.cpp b/src/corelib/kernel/qbasictimer.cpp index cf9c0bbccd..2aea3269a0 100644 --- a/src/corelib/kernel/qbasictimer.cpp +++ b/src/corelib/kernel/qbasictimer.cpp @@ -33,9 +33,6 @@ QT_BEGIN_NAMESPACE can maintain a list of basic timers by holding them in container that supports move-only types, e.g. std::vector. - The \l{widgets/tetrix}{Tetrix} example uses QBasicTimer to control - the rate at which pieces fall. - \sa QTimer, QTimerEvent, QObject::timerEvent(), Timers, {Affine Transformations} */ diff --git a/src/corelib/plugin/qpluginloader.cpp b/src/corelib/plugin/qpluginloader.cpp index 812ee58825..aff9550685 100644 --- a/src/corelib/plugin/qpluginloader.cpp +++ b/src/corelib/plugin/qpluginloader.cpp @@ -71,7 +71,7 @@ using namespace Qt::StringLiterals; link to plugins statically. You can use QLibrary if you need to load dynamic libraries in a statically linked application. - \sa QLibrary, {Plug & Paint Example} + \sa QLibrary, {Echo Plugin Example} */ static constexpr QLibrary::LoadHints defaultLoadHints = QLibrary::PreventUnloadHint; diff --git a/src/corelib/tools/qset.qdoc b/src/corelib/tools/qset.qdoc index 759a2c626b..e0d4278935 100644 --- a/src/corelib/tools/qset.qdoc +++ b/src/corelib/tools/qset.qdoc @@ -887,11 +887,9 @@ any. */ -/*! \fn template <class T> template <class Predicate> qsizetype QSet<T>::removeIf(Predicate pred) - \relates QSet +/*! \fn template <class T> template <class Pred> qsizetype QSet<T>::removeIf(Pred pred) \since 6.1 - Removes all elements for which the predicate \a pred returns true - from the set \a set. Returns the number of elements removed, if - any. + Removes, from this set, all elements for which the predicate \a pred + returns \c true. Returns the number of elements removed, if any. */ diff --git a/src/dbus/doc/qtdbus.qdocconf b/src/dbus/doc/qtdbus.qdocconf index f45f98dd8f..90ee5743ff 100644 --- a/src/dbus/doc/qtdbus.qdocconf +++ b/src/dbus/doc/qtdbus.qdocconf @@ -65,3 +65,6 @@ navigation.cppclassespage = "Qt D-Bus C++ Classes" manifestmeta.thumbnail.names = "QtDBus/D-Bus Ping Pong" \ "QtDBus/D-Bus Complex Ping Pong" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/gui/doc/qtgui.qdocconf b/src/gui/doc/qtgui.qdocconf index 0ba514522c..b94f11849c 100644 --- a/src/gui/doc/qtgui.qdocconf +++ b/src/gui/doc/qtgui.qdocconf @@ -74,3 +74,6 @@ spurious += "Undocumented enum item '.*' in QGradient::Preset" # \svgcolor {#ffdead} macro.svgcolor.HTML = "<div style=\"padding:10px;color:#fff;background:\1;\"></div>" macro.svgcolor.DocBook = "<db:phrase role=\"color:\1\">          </db:phrase>" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/gui/doc/src/dnd.qdoc b/src/gui/doc/src/dnd.qdoc index e8276f3465..7a756b304e 100644 --- a/src/gui/doc/src/dnd.qdoc +++ b/src/gui/doc/src/dnd.qdoc @@ -335,7 +335,9 @@ For example, we can copy the contents of a QLineEdit to the clipboard with the following code: - \snippet ../widgets/widgets/charactermap/mainwindow.cpp 11 + \code + QGuiApplication::clipboard()->setText(lineEdit->text(), QClipboard::Clipboard); + \endcode Data with different MIME types can also be put on the clipboard. Construct a QMimeData object and set data with setData() function in @@ -364,8 +366,6 @@ \li \l{draganddrop/draggableicons}{Draggable Icons} \li \l{draganddrop/draggabletext}{Draggable Text} \li \l{draganddrop/dropsite}{Drop Site} - \li \l{draganddrop/fridgemagnets}{Fridge Magnets} - \li \l{draganddrop/puzzle}{Drag and Drop Puzzle} \endlist \section1 Interoperating with Other Applications diff --git a/src/gui/image/qicon.cpp b/src/gui/image/qicon.cpp index fb356f19b2..5205f2b2f6 100644 --- a/src/gui/image/qicon.cpp +++ b/src/gui/image/qicon.cpp @@ -1154,7 +1154,7 @@ QStringList QIcon::themeSearchPaths() The fallback search paths are consulted for standalone icon files if the \l{themeName()}{current icon theme} - or \l{fallbackIconTheme()}{fallback icon theme} do + or \l{fallbackThemeName()}{fallback icon theme} do not provide results for an icon lookup. If not set, the fallback search paths will be defined @@ -1174,7 +1174,7 @@ QStringList QIcon::fallbackSearchPaths() The fallback search paths are consulted for standalone icon files if the \l{themeName()}{current icon theme} - or \l{fallbackIconTheme()}{fallback icon theme} do + or \l{fallbackThemeName()}{fallback icon theme} do not provide results for an icon lookup. For example: diff --git a/src/network/doc/qtnetwork.qdocconf b/src/network/doc/qtnetwork.qdocconf index 4aca610e36..207467dca0 100644 --- a/src/network/doc/qtnetwork.qdocconf +++ b/src/network/doc/qtnetwork.qdocconf @@ -39,3 +39,6 @@ imagedirs += images \ navigation.landingpage = "Qt Network" navigation.cppclassespage = "Qt Network C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/opengl/doc/qtopengl.qdocconf b/src/opengl/doc/qtopengl.qdocconf index 7d689a2f70..7af173aac8 100644 --- a/src/opengl/doc/qtopengl.qdocconf +++ b/src/opengl/doc/qtopengl.qdocconf @@ -63,3 +63,6 @@ qhp.QtOpenGL.subprojects.classes.sortPages = true navigation.landingpage = "Qt OpenGL" navigation.cppclassespage = "Qt OpenGL C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/printsupport/doc/qtprintsupport.qdocconf b/src/printsupport/doc/qtprintsupport.qdocconf index 28d6502c64..f1b541bafb 100644 --- a/src/printsupport/doc/qtprintsupport.qdocconf +++ b/src/printsupport/doc/qtprintsupport.qdocconf @@ -40,3 +40,6 @@ imagedirs += images \ navigation.landingpage = "Qt Print Support" navigation.cppclassespage = "Qt Print Support C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/sql/doc/qtsql.qdocconf b/src/sql/doc/qtsql.qdocconf index 47c172d54b..06b09771ba 100644 --- a/src/sql/doc/qtsql.qdocconf +++ b/src/sql/doc/qtsql.qdocconf @@ -39,3 +39,6 @@ imagedirs += images \ navigation.landingpage = "Qt SQL" navigation.cppclassespage = "Qt SQL C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/testlib/doc/qttestlib.qdocconf b/src/testlib/doc/qttestlib.qdocconf index a5727e1d48..8b245a864f 100644 --- a/src/testlib/doc/qttestlib.qdocconf +++ b/src/testlib/doc/qttestlib.qdocconf @@ -55,3 +55,6 @@ manifestmeta.thumbnail.names = "QtTestLib/Chapter *" navigation.landingpage = "Qt Test" navigation.cppclassespage = "Qt Test C++ Classes" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index 4f2d74afd6..36671430cc 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -26,7 +26,20 @@ qhp.QtWidgets.subprojects.classes.sortPages = true tagfile = ../../../doc/qtwidgets/qtwidgets.tags -depends += qtcore qtgui qtdoc qtsql qtdesigner qtquick qmake qtcmake qtsvg qtlinguist qthelp +depends += \ + qtcore \ + qtgui \ + qtdoc \ + qtsql \ + qtdesigner \ + qtquick \ + qmake \ + qtcmake \ + qtsvg \ + qtlinguist \ + qthelp \ + qtopengl \ + qtshadertools headerdirs += .. @@ -64,3 +77,6 @@ navigation.cppclassespage = "Qt Widgets C++ Classes" manifestmeta.highlighted.names = \ "QtWidgets/Editable Tree Model Example" \ "QtWidgets/Menus Example" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/xml/doc/qtxml.qdocconf b/src/xml/doc/qtxml.qdocconf index f11b7c6c0f..63d934943b 100644 --- a/src/xml/doc/qtxml.qdocconf +++ b/src/xml/doc/qtxml.qdocconf @@ -38,3 +38,6 @@ navigation.cppclassespage = "Qt XML C++ Classes" # Add a thumbnail for examples that do not have images manifestmeta.thumbnail.names = "QtXml/XML Stream Lint Example" + +# Enforce zero documentation warnings +warninglimit = 0 |