AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix some qdoc warnings from QStaticPlugin

Browse Source 
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>
This commit is contained in:
Volker Hilsheimer 2020-09-24 13:14:51 +02:00
parent 7542638e0c
commit 4ccebdf12d
1 changed files with 25 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/corelib/plugin/qpluginloader.cpp
View File

@ -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
{