Doc: Fix IPlugin class docs

Fix \fn command values and document missing enum and arguments.

Remove unnecessary \fn commands, so that the signatures don't
need to be maintained.

Fix formatting and language issues.

Task-number: QTCREATORBUG-23544
Change-Id: Iddddb704a51e7a4fa9ac79fa2d4a89aa6abeefd5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-02-04 17:35:50 +01:00
parent a804f6b193
commit bab8c9b91f
2 changed files with 62 additions and 41 deletions

View File

@@ -55,7 +55,8 @@ depends += qtwidgets \
qtsensors \
qtuitools \
qtwebkit \
qtxml
qtxml \
qttestlib
include(macros.qdocconf)
include(qt-cpp-ignore.qdocconf)

View File

@@ -30,22 +30,20 @@
/*!
\class ExtensionSystem::IPlugin
\mainclass
\ingroup mainclasses
\brief The IPlugin class is the base class for all plugins.
The IPlugin class is an abstract class that must be implemented
once for each plugin.
A plugin consists of two parts: A description file, and a library
A plugin consists of two parts: a description file, and a library
that at least contains the IPlugin implementation.
\tableofcontents
\section1 Plugin Specification
A plugin needs to provide a plugin specification file in addition
to the actual plugin library, so the plugin manager can find the plugin,
resolve its dependencies, and load it. For more information,
see \l{Plugin Specifications}.
see \l{Plugin Meta Data}.
\section1 Plugin Implementation
Plugins must provide one implementation of the IPlugin class, located
@@ -65,7 +63,7 @@
needed by other plugins and register them via appropriate core functions
or, if a weak dependency is neceessary to be implemented, to put
them into the global object pool.
\li All plugins' extensionsInitialized functions are called in \e{leaf-to-root}
\li All plugins' extensionsInitialized() functions are called in \e{leaf-to-root}
order of the dependency tree. At this point, plugins can
be sure that all plugins that depend on this plugin have
been initialized completely and objects these plugins wish to
@@ -75,17 +73,31 @@
that depend on that plugin also fail.
*/
/*!
\enum IPlugin::ShutdownFlag
This enum type holds whether the plugin is shut down synchronously or
asynchronously.
\value SynchronousShutdown
The plugin is shut down synchronously.
\value AsynchronousShutdown
The plugin needs to perform asynchronous
actions before it shuts down.
*/
/*!
\fn bool IPlugin::initialize(const QStringList &arguments, QString *errorString)
\brief 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.
The initialize functions of plugins that depend
on this plugin are called after the initialize function of this plugin
has been called. Plugins should initialize their internal state in this
function. Returns if initialization of successful. If it wasn't successful,
the \a errorString should be set to a user-readable message
describing the reason.
The initialize functions of plugins that depend on this plugin are called
after the initialize function of this plugin has been called with
\a arguments. Plugins should initialize their internal state in this
function.
Returns whether initialization succeeds. If it does not, \a errorString
should be set to a user-readable message describing the reason.
\sa extensionsInitialized()
\sa delayedInitialize()
@@ -93,12 +105,12 @@
/*!
\fn void IPlugin::extensionsInitialized()
\brief Called after the IPlugin::initialize() function has been called,
and after both the IPlugin::initialize() and IPlugin::extensionsInitialized()
Called after the initialize() function has been called,
and after both the initialize() and \c extensionsInitialized()
functions of plugins that depend on this plugin have been called.
In this function, the plugin can assume that plugins that depend on
this plugin are fully 'up and running'. It is a good place to
this plugin are fully \e {up and running}. It is a good place to
look in the global object pool for objects that have been provided
by weakly dependent plugins.
@@ -108,19 +120,21 @@
/*!
\fn bool IPlugin::delayedInitialize()
\brief Called after all plugins' IPlugin::extensionsInitialized() function has been called,
and after the IPlugin::delayedInitialize() function of plugins that depend on this plugin
have been called.
Called after all plugins' extensionsInitialized() function has been called,
and after the \c delayedInitialize() function of plugins that depend on this
plugin have been called.
The plugins' delayedInitialize() functions are called after the application is already running,
with a few milliseconds delay to application startup, and between individual delayedInitialize
function calls. To avoid unnecessary delays, a plugin should return true from the function if it
actually implements it, to indicate that the next plugins' delayedInitialize() call should
be delayed a few milliseconds to give input and paint events a chance to be processed.
The plugins' \c delayedInitialize() functions are called after the
application is already running, with a few milliseconds delay to
application startup, and between individual \c delayedInitialize()
function calls. To avoid unnecessary delays, a plugin should return
\c true from the function if it actually implements it, to indicate
that the next plugins' \c delayedInitialize() call should be delayed
a few milliseconds to give input and paint events a chance to be processed.
This function can be used if a plugin needs to do non-trivial setup that doesn't
necessarily need to be done directly at startup, but still should be done within a
short time afterwards. This can decrease the felt plugin/application startup
short time afterwards. This can decrease the perceived plugin or application startup
time a lot, with very little effort.
\sa initialize()
@@ -129,7 +143,7 @@
/*!
\fn IPlugin::ShutdownFlag IPlugin::aboutToShutdown()
\brief 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.
This function should be used to disconnect from other plugins,
@@ -138,34 +152,44 @@
it needs to wait for external processes to finish for a clean shutdown,
the plugin can return IPlugin::AsynchronousShutdown from this function. This
will keep the main event loop running after the aboutToShutdown() sequence
has finished, until all plugins requesting AsynchronousShutdown have sent
has finished, until all plugins requesting asynchronous shutdown have sent
the asynchronousShutdownFinished() signal.
The default implementation of this function does nothing and returns
IPlugin::SynchronousShutdown.
Returns IPlugin::AsynchronousShutdown if the plugin needs to perform
asynchronous actions before performing the shutdown.
asynchronous actions before shutdown.
\sa asynchronousShutdownFinished()
*/
/*!
\fn QObject *IPlugin::remoteCommand(const QStringList &options, const QStringList &arguments)
\brief When \QC is executed with the -client argument while already another instance of \QC
is running, this function of plugins is called in the running instance.
\fn QObject *IPlugin::remoteCommand(const QStringList &options,
const QString &workingDirectory,
const QStringList &arguments)
When \QC is executed with the \c -client argument while another \QC instance
is running, this function of the plugin is called in the running instance.
The \a workingDirectory argument specifies the working directory of the
calling process. For example, if you're in a directory, and you execute
\c { qtcreator -client file.cpp}, the working directory of the calling
process is passed to the running instance and \c {file.cpp} is transformed
into an absolute path starting from this directory.
Plugin-specific arguments are passed in \a options, while the rest of the
arguments are passed in \a arguments.
\returns a QObject that blocks the command until it is destroyed, if -block is used.
Returns a QObject that blocks the command until it is destroyed, if \c -block
is used.
\sa PluginManager::serializedArguments()
*/
/*!
\fn void IPlugin::asynchronousShutdownFinished()
Sent by the plugin implementation after a asynchronous shutdown
Sent by the plugin implementation after an asynchronous shutdown
is ready to proceed with the shutdown sequence.
\sa aboutToShutdown()
@@ -174,7 +198,6 @@
using namespace ExtensionSystem;
/*!
\fn IPlugin::IPlugin()
\internal
*/
IPlugin::IPlugin()
@@ -183,7 +206,6 @@ IPlugin::IPlugin()
}
/*!
\fn IPlugin::~IPlugin()
\internal
*/
IPlugin::~IPlugin()
@@ -193,11 +215,10 @@ IPlugin::~IPlugin()
}
/*!
\fn QVector<QObject *> IPlugin::createTestObjects() const
Returns objects that are meant to be passed on to \l QTest::qExec().
Returns objects that are meant to be passed on to QTest::qExec().
This function will be called if the user starts \QC with '-test PluginName' or '-test all'.
This function will be called if the user starts \QC with
\c {-test PluginName} or \c {-test all}.
The ownership of returned objects is transferred to caller.
*/
@@ -207,7 +228,6 @@ QVector<QObject *> IPlugin::createTestObjects() const
}
/*!
\fn PluginSpec *IPlugin::pluginSpec() const
Returns the PluginSpec corresponding to this plugin.
This is not available in the constructor.
*/