aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-07 11:23:56 +0100
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2020-02-07 10:42:05 +0000
commitc42ca50537028bccb40a2eb3014677857ea516d4 (patch)
treefbae22e14dfe700dfd0c9c73d32ef1582b063557
parent4d4a93025676fc1f5bc55ebc01340c555258447e (diff)
Doc: Remove info from ExtensionSystem::IPlugin doc
Remove obsolete and duplicate info and link to overview topics instead. Task-number: QTCREATORBUG-23544 Change-Id: Ic06cffdf08c483029caa7e42b7eb222d62be84cf Reviewed-by: Eike Ziller <eike.ziller@qt.io>
-rw-r--r--src/libs/extensionsystem/iplugin.cpp41
1 files changed, 7 insertions, 34 deletions
diff --git a/src/libs/extensionsystem/iplugin.cpp b/src/libs/extensionsystem/iplugin.cpp
index f0cc3d2247..ede65b0c5d 100644
--- a/src/libs/extensionsystem/iplugin.cpp
+++ b/src/libs/extensionsystem/iplugin.cpp
@@ -30,47 +30,22 @@
/*!
\class ExtensionSystem::IPlugin
+ \inmodule QtCreator
\ingroup mainclasses
- \brief The IPlugin class is the base class for all plugins.
-
- The IPlugin class is an abstract class that must be implemented
+ \brief The IPlugin class is an abstract base class that must be implemented
once for each plugin.
- A plugin consists of two parts: a description file, and a library
- that at least contains the IPlugin implementation.
-
- \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 Meta Data}.
+ A plugin needs to provide meta data 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 Meta Data}.
- \section1 Plugin Implementation
Plugins must provide one implementation of the IPlugin class, located
in a library that matches the \c name attribute given in their
- XML description. The IPlugin implementation must be exported and
+ meta data. The IPlugin implementation must be exported and
made known to Qt's plugin system, using the \c Q_PLUGIN_METADATA macro with
an IID set to \c "org.qt-project.Qt.QtCreatorPlugin".
-
- After the plugins' XML files have been read, and dependencies have been
- found, the plugin loading is done in three phases:
- \list 1
- \li All plugin libraries are loaded in \e{root-to-leaf} order of the
- dependency tree.
- \li All plugins' initialize functions are called in \e{root-to-leaf} order
- of the dependency tree. This is a good time to create objects
- 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}
- 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
- share have been registered or are available in the global object pool.
- \endlist
- If library loading or initialization of a plugin fails, all plugins
- that depend on that plugin also fail.
+ For more information, see \l{Plugin Life Cycle}.
*/
/*!
@@ -183,8 +158,6 @@
Returns a QObject that blocks the command until it is destroyed, if \c -block
is used.
-
- \sa PluginManager::serializedArguments()
*/
/*!