Doc: Resolve documentation warnings

- QDoc Manual: UIComponents example project has been moved to be a part
  of test case - remove references to it from the manual.

- Add missing image.

- Document the namespace qdesigner_internal as \internal.

Fixes: QTBUG-79833
Change-Id: Ic0984cef4091e794de5e502d04a897b1f532d9d8
Reviewed-by: Paul Wicking <paul.wicking@qt.io>

9 files changed, 19 insertions, 26 deletions

diff --git a/examples/designer/doc/src/containerextension.qdoc b/examples/designer/doc/src/containerextension.qdoc
index ce5d161ff..c72868554 100644
--- a/examples/designer/doc/src/containerextension.qdoc
+++ b/examples/designer/doc/src/containerextension.qdoc
@@ -171,11 +171,10 @@
     another page or changes one of the page titles. To be able to give
     each page their own title, we have chosen to use the
     QWidget::windowTitle property to store the page title (for more
-    information see the MultiPageWidget class \l
-    {containerextension/multipagewidget.cpp}{implementation}). Note
-    that currently there is no way of adding a custom property (e.g.,
-    a page title) to the pages without using a predefined property as
-    placeholder.
+    information see the MultiPageWidget class implementation in
+    \e containerextension/multipagewidget.cpp. Note that currently there
+    is no way of adding a custom property (for example, a page title) to
+    the pages without using a predefined property as placeholder.
 
     The \c MultiPageWidgetPlugin class inherits from both QObject and
     QDesignerCustomWidgetInterface. It is important to remember, when
@@ -279,8 +278,8 @@
     QDesignerPropertySheetExtension::indexOf() function. As previously
     mentioned, we have chosen to use the QWidget::windowTitle property
     to store the page title (for more information see the
-    MultiPageWidget class \l
-    {containerextension/multipagewidget.cpp}{implementation}).
+    MultiPageWidget class implementation in
+    \e containerextension/multipagewidget.cpp.
     Finally, we implicitly force an update of the page's property
     sheet by calling the
     QDesignerPropertySheetExtension::setChanged() function.
@@ -489,7 +488,6 @@
     updated whenever the user views another page or changes one of the
     page titles.
 
-    See the MultiPageWidget class \l
-    {containerextension/multipagewidget.cpp}{implementation}
-    for more details.
+    See the MultiPageWidget class implementation in
+    \e containerextension/multipagewidget.cpp for more details.
 */
diff --git a/src/assistant/help/qhelpfilterdata.cpp b/src/assistant/help/qhelpfilterdata.cpp
index 37b209541..b90aeb6c8 100644
--- a/src/assistant/help/qhelpfilterdata.cpp
+++ b/src/assistant/help/qhelpfilterdata.cpp
@@ -107,7 +107,7 @@ QHelpFilterData &QHelpFilterData::operator=(const QHelpFilterData &) = default;
 QHelpFilterData &QHelpFilterData::operator=(QHelpFilterData &&) = default;
 
 /*!
-    \fn void QHelpFilterData::swap(QCompressedHelpInfo &other)
+    \fn void QHelpFilterData::swap(QHelpFilterData &other)
 
     Swaps the filter \a other with this filter. This
     operation is very fast and never fails.
diff --git a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc
index eaf816f42..b13f2ae9f 100644
--- a/src/designer/src/designer/doc/src/qtdesigner-module.qdoc
+++ b/src/designer/src/designer/doc/src/qtdesigner-module.qdoc
@@ -46,3 +46,8 @@
 
     \snippet plugins/doc_src_qtdesigner.pro 1
 */
+
+/*!
+    \namespace qdesigner_internal
+    \internal
+*/
diff --git a/src/designer/src/lib/sdk/abstractpromotioninterface.cpp b/src/designer/src/lib/sdk/abstractpromotioninterface.cpp
index 90f820330..7443d5cf8 100644
--- a/src/designer/src/lib/sdk/abstractpromotioninterface.cpp
+++ b/src/designer/src/lib/sdk/abstractpromotioninterface.cpp
@@ -56,7 +56,7 @@ QDesignerPromotionInterface::~QDesignerPromotionInterface()
 */
 
 /*!
-    \fn virtual QDesignerPromotionInterface::PromotedClasses promotedClasses()  const
+    \fn QDesignerPromotionInterface::PromotedClasses QDesignerPromotionInterface::promotedClasses() const
 
     Returns a list of promoted classes along with their base classes in alphabetical order.
     It can be used to populate tree models for editing promoted widgets.
diff --git a/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp b/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp
index 91332b0ec..243a2cac7 100644
--- a/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp
+++ b/src/designer/src/lib/shared/qdesigner_formwindowmanager.cpp
@@ -38,6 +38,7 @@ using namespace qdesigner_internal;
 /*!
     \class qdesigner_internal::QDesignerFormWindowManager
     \inmodule QtDesigner
+    \internal
 
     Extends QDesignerFormWindowManagerInterface with methods to control
     the preview and printing of forms. It provides a facade that simplifies
diff --git a/src/designer/src/lib/uilib/abstractformbuilder.cpp b/src/designer/src/lib/uilib/abstractformbuilder.cpp
index e57237dd0..b723b7a34 100644
--- a/src/designer/src/lib/uilib/abstractformbuilder.cpp
+++ b/src/designer/src/lib/uilib/abstractformbuilder.cpp
@@ -1212,7 +1212,7 @@ QActionGroup *QAbstractFormBuilder::createActionGroup(QObject *parent, const QSt
     Therefore, you should remove properties that are not required from your
     resulting XML files, before loading them. Alternatively, if you already
     know which properties you want to save when you call this method,
-    you can overload \l computeProperties() and return a filtered list of
+    you can overload \c computeProperties() and return a filtered list of
     required properties. Otherwise, unexpected behavior may occur as some
     of these properties may depend on each other.
 
diff --git a/src/qdoc/doc/images/windowsvista-toolbutton.png b/src/qdoc/doc/images/windowsvista-toolbutton.png
new file mode 100644
index 000000000..0baa9809c
--- /dev/null
+++ b/src/qdoc/doc/images/windowsvista-toolbutton.png
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
index fd6dc7a75..201706b70 100644
--- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
+++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc
@@ -541,26 +541,21 @@
     For example, if a type called \c TabWidget is in the \c UIComponents
     module, it must be linked as \c {UIComponents::TabWidget}.
 
-    The \l{componentset}{UIComponents} example demonstrates proper usage of
-    QDoc commands to document QML types and QML modules.
-
     \section3 Read-only and Internal QML Properties
 
     QDoc detects QML properties that are marked as \c readonly. Note that the
     property must be initialized with a value.
 
-    \code
+    \badcode
         readonly property int sampleReadOnlyProperty: 0
     \endcode
-    For example, the example \l{TabWidget} type has a fictitious read-only
-    property \c sampleReadOnlyProperty. Its declaration has the \c readonly
-    identifier and it has an initial value.
 
     Properties and signals that are not meant for the public interface may
     be marked with the \l{internal-command}{\\internal} command. QDoc will not
     publish the documentation in the generated outputs.
 
     \section1 Articles & Overviews
+
     Articles and overviews are a style of writing best used for providing
     summary detail on a topic or concept. It may introduce a technology or
     discuss how a concept may be applied, but without discussing exact steps
diff --git a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
index 4e80f8f12..5c3de3a98 100644
--- a/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
+++ b/src/qdoc/doc/qdoc-manual-topiccmds.qdoc
@@ -1365,9 +1365,6 @@
         responds to a \c clicked() event.
     \endcode
 
-    The \l{componentset}{UIComponents} example demonstrates proper usage of
-    QDoc commands to document QML types and QML modules.
-
     \target inqmlmodule-command
     \section1 \\inqmlmodule
 
@@ -1387,9 +1384,6 @@
     To link to the \c ClickableButton, use the
     \c{\l ClickableComponents::ClickableButton} format.
 
-    The \l{componentset}{UIComponents} example demonstrates proper usage of
-    QDoc commands to document QML types and QML modules.
-
     The \l {noautolist-command} {\\noautolist} command can be used here
     to omit the automatically generated list of types at the end.