From 4ccebdf12d27bfd7049ef2da0e6183539c94aa7a Mon Sep 17 00:00:00 2001
From: Volker Hilsheimer <volker.hilsheimer@qt.io>
Date: Thu, 24 Sep 2020 13:14:51 +0200
Subject: Fix some qdoc warnings from QStaticPlugin

Move all the documentation for that class into one place, and remove
rawMetaData documentation and references; it is a private variable, and
shouldn't be documented.

The instance member is a function pointer type variable, but should
be treated as a member function. Even with a Q_QDOC ifdef'ery we can't fix
that warning (we would get a lot of new warnings instead), so leave that
as is for now.

Change-Id: I951aaafad8dca5ed2533ace69931f002eb97996a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
---
 src/corelib/plugin/qpluginloader.cpp | 53 +++++++++++++++++-------------------
 1 file changed, 25 insertions(+), 28 deletions(-)

(limited to 'src/corelib/plugin')

diff --git a/src/corelib/plugin/qpluginloader.cpp b/src/corelib/plugin/qpluginloader.cpp
index ef8ad108cb..f957c75ab8 100644
--- a/src/corelib/plugin/qpluginloader.cpp
+++ b/src/corelib/plugin/qpluginloader.cpp
@@ -105,33 +105,6 @@ QT_BEGIN_NAMESPACE
     \sa QLibrary, {Plug & Paint Example}
 */
 
-/*!
-    \class QStaticPlugin
-    \inmodule QtCore
-    \since 5.2
-
-    \brief QStaticPlugin is a struct containing a reference to a
-    static plugin instance together with its meta data.
-
-    \sa QPluginLoader, {How to Create Qt Plugins}
-*/
-
-/*!
-    \fn QObject *QStaticPlugin::instance()
-
-    Returns the plugin instance.
-
-    \sa QPluginLoader::staticInstances()
-*/
-
-/*!
-    \fn const char *QStaticPlugin::rawMetaData()
-
-    Returns the raw meta data for the plugin.
-
-    \sa metaData(), Q_PLUGIN_METADATA()
-*/
-
 /*!
     Constructs a plugin loader with the given \a parent.
 */
@@ -475,10 +448,34 @@ QList<QStaticPlugin> QPluginLoader::staticPlugins()
     return QList<QStaticPlugin>();
 }
 
+/*!
+    \class QStaticPlugin
+    \inmodule QtCore
+    \since 5.2
+
+    \brief QStaticPlugin is a struct containing a reference to a
+    static plugin instance together with its meta data.
+
+    \sa QPluginLoader, {How to Create Qt Plugins}
+*/
+
+/*!
+    \fn QStaticPlugin::QStaticPlugin(QtPluginInstanceFunction i, QtPluginMetaDataFunction m)
+    \internal
+*/
+
+/*!
+    \fn QObject *QStaticPlugin::instance()
+
+    Returns the plugin instance.
+
+    \sa QPluginLoader::staticInstances()
+*/
+
 /*!
     Returns a the meta data for the plugin as a QJsonObject.
 
-    \sa rawMetaData()
+    \sa Q_PLUGIN_METADATA()
 */
 QJsonObject QStaticPlugin::metaData() const
 {
-- 
cgit v1.2.3