Fix extensionsystem API documentation for new qdoc

Change-Id: I2303e46a3e5840a3c23c84a9126237eeb2eb21d9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Eike Ziller
2020-02-20 10:19:56 +01:00
parent db7d12b78c
commit 6f1ad0b0cb
3 changed files with 23 additions and 20 deletions

View File

@@ -62,7 +62,7 @@
*/ */
/*! /*!
\fn bool IPlugin::initialize(const QStringList &arguments, QString *errorString) \fn bool ExtensionSystem::IPlugin::initialize(const QStringList &arguments, QString *errorString)
Called after the plugin has been loaded and the IPlugin instance Called after the plugin has been loaded and the IPlugin instance
has been created. has been created.
@@ -79,7 +79,7 @@
*/ */
/*! /*!
\fn void IPlugin::extensionsInitialized() \fn void ExtensionSystem::IPlugin::extensionsInitialized()
Called after the initialize() function has been called, Called after the initialize() function has been called,
and after both the initialize() and \c extensionsInitialized() and after both the initialize() and \c extensionsInitialized()
functions of plugins that depend on this plugin have been called. functions of plugins that depend on this plugin have been called.
@@ -94,7 +94,7 @@
*/ */
/*! /*!
\fn bool IPlugin::delayedInitialize() \fn bool ExtensionSystem::IPlugin::delayedInitialize()
Called after all plugins' extensionsInitialized() function has been called, Called after all plugins' extensionsInitialized() function has been called,
and after the \c delayedInitialize() function of plugins that depend on this and after the \c delayedInitialize() function of plugins that depend on this
plugin have been called. plugin have been called.
@@ -117,7 +117,7 @@
*/ */
/*! /*!
\fn IPlugin::ShutdownFlag IPlugin::aboutToShutdown() \fn ExtensionSystem::IPlugin::ShutdownFlag ExtensionSystem::IPlugin::aboutToShutdown()
Called during a shutdown sequence in the same order as initialization Called during a shutdown sequence in the same order as initialization
before the plugins get deleted in reverse order. before the plugins get deleted in reverse order.
@@ -140,7 +140,7 @@
*/ */
/*! /*!
\fn QObject *IPlugin::remoteCommand(const QStringList &options, \fn QObject *ExtensionSystem::IPlugin::remoteCommand(const QStringList &options,
const QString &workingDirectory, const QString &workingDirectory,
const QStringList &arguments) const QStringList &arguments)
@@ -161,7 +161,7 @@
*/ */
/*! /*!
\fn void IPlugin::asynchronousShutdownFinished() \fn void ExtensionSystem::IPlugin::asynchronousShutdownFinished()
Sent by the plugin implementation after an asynchronous shutdown Sent by the plugin implementation after an asynchronous shutdown
is ready to proceed with the shutdown sequence. is ready to proceed with the shutdown sequence.

View File

@@ -213,7 +213,7 @@ enum { debugLeaks = 0 };
*/ */
/*! /*!
\fn T *PluginManager::getObject() \fn template <typename T> *ExtensionSystem::PluginManager::getObject()
Retrieves the object of a given type from the object pool. Retrieves the object of a given type from the object pool.
@@ -225,7 +225,7 @@ enum { debugLeaks = 0 };
*/ */
/*! /*!
\fn T *PluginManager::getObject(Predicate predicate) \fn template <typename T, typename Predicate> *ExtensionSystem::PluginManager::getObject(Predicate predicate)
Retrieves the object of a given type from the object pool that matches Retrieves the object of a given type from the object pool that matches
the \a predicate. the \a predicate.
@@ -618,7 +618,7 @@ static QStringList subList(const QStringList &in, const QString &key)
} }
/*! /*!
Parses the options encoded by serializedArguments() const Parses the options encoded in \a serializedArgument
and passes them on to the respective plugins along with the arguments. and passes them on to the respective plugins along with the arguments.
\a socket is passed for disconnecting the peer when the operation is done (for example, \a socket is passed for disconnecting the peer when the operation is done (for example,
@@ -704,7 +704,9 @@ static inline void formatOption(QTextStream &str,
} }
/*! /*!
Formats the startup options of the plugin manager for command line help. Formats the startup options of the plugin manager for command line help with the specified
\a optionIndentation and \a descriptionIndentation.
Adds the result to \a str.
*/ */
void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int descriptionIndentation)
@@ -741,7 +743,9 @@ void PluginManager::formatOptions(QTextStream &str, int optionIndentation, int d
} }
/*! /*!
Formats the plugin options of the plugin specs for command line help. Formats the plugin options of the plugin specs for command line help with the specified
\a optionIndentation and \a descriptionIndentation.
Adds the result to \a str.
*/ */
void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation) void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation, int descriptionIndentation)
@@ -758,7 +762,7 @@ void PluginManager::formatPluginOptions(QTextStream &str, int optionIndentation,
} }
/*! /*!
Formats the version of the plugin specs for command line help. Formats the version of the plugin specs for command line help and adds it to \a str.
*/ */
void PluginManager::formatPluginVersions(QTextStream &str) void PluginManager::formatPluginVersions(QTextStream &str)
{ {
@@ -767,7 +771,7 @@ void PluginManager::formatPluginVersions(QTextStream &str)
} }
/*! /*!
* \internal \internal
*/ */
bool PluginManager::testRunRequested() bool PluginManager::testRunRequested()
{ {
@@ -775,8 +779,7 @@ bool PluginManager::testRunRequested()
} }
/*! /*!
Creates a profiling entry showing the elapsed time if profiling is \internal
activated.
*/ */
void PluginManager::profilingReport(const char *what, const PluginSpec *spec) void PluginManager::profilingReport(const char *what, const PluginSpec *spec)

View File

@@ -57,19 +57,19 @@
*/ */
/*! /*!
\fn void PluginView::currentPluginChanged(ExtensionSystem::PluginSpec *spec) \fn void ExtensionSystem::PluginView::currentPluginChanged(ExtensionSystem::PluginSpec *spec)
The current selection in the plugin list has changed to the The current selection in the plugin list has changed to the
plugin corresponding to \a spec. plugin corresponding to \a spec.
*/ */
/*! /*!
\fn void PluginView::pluginActivated(ExtensionSystem::PluginSpec *spec) \fn void ExtensionSystem::PluginView::pluginActivated(ExtensionSystem::PluginSpec *spec)
The plugin list entry corresponding to \a spec has been activated, The plugin list entry corresponding to \a spec has been activated,
for example by a double-click. for example by a double-click.
*/ */
/*! /*!
\fn void PluginView::pluginSettingsChanged(ExtensionSystem::PluginSpec *spec) \fn void ExtensionSystem::PluginView::pluginSettingsChanged(ExtensionSystem::PluginSpec *spec)
The settings for the plugin list entry corresponding to \a spec changed. The settings for the plugin list entry corresponding to \a spec changed.
*/ */