diff options
Diffstat (limited to 'src/libs/extensionsystem')
| -rw-r--r-- | src/libs/extensionsystem/iplugin.cpp | 42 | ||||
| -rw-r--r-- | src/libs/extensionsystem/pluginerrorview.cpp | 2 | ||||
| -rw-r--r-- | src/libs/extensionsystem/pluginmanager.cpp | 20 | ||||
| -rw-r--r-- | src/libs/extensionsystem/pluginspec.cpp | 6 |
4 files changed, 35 insertions, 35 deletions
diff --git a/src/libs/extensionsystem/iplugin.cpp b/src/libs/extensionsystem/iplugin.cpp index 132e5078f38..e8670620684 100644 --- a/src/libs/extensionsystem/iplugin.cpp +++ b/src/libs/extensionsystem/iplugin.cpp @@ -64,10 +64,10 @@ \list 1 \li All plugin libraries are loaded in \e{root-to-leaf} order of the dependency tree. - \li All plugins' initialize methods are called in \e{root-to-leaf} order + \li All plugins' initialize functions are called in \e{root-to-leaf} order of the dependency tree. This is a good place to put objects in the plugin manager's object pool. - \li All plugins' extensionsInitialized methods 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 (implying that they have put @@ -79,7 +79,7 @@ Plugins have access to the plugin manager (and its object pool) via the PluginManager::instance() - method. + function. */ /*! @@ -87,10 +87,10 @@ \brief Called after the plugin has been loaded and the IPlugin instance has been created. - The initialize methods of plugins that depend - on this plugin are called after the initialize method of this plugin + 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 - method. Returns if initialization of successful. If it wasn't successful, + 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. @@ -100,11 +100,11 @@ /*! \fn void IPlugin::extensionsInitialized() - \brief Called after the IPlugin::initialize() method has been called, + \brief Called after the IPlugin::initialize() function has been called, and after both the IPlugin::initialize() and IPlugin::extensionsInitialized() - methods of plugins that depend on this plugin have been called. + functions of plugins that depend on this plugin have been called. - In this method, the plugin can assume that plugins that depend on + 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 look in the plugin manager's object pool for objects that have been provided by dependent plugins. @@ -115,17 +115,17 @@ /*! \fn bool IPlugin::delayedInitialize() - \brief Called after all plugins' IPlugin::extensionsInitialized() method has been called, - and after the IPlugin::delayedInitialize() method of plugins that depend on this plugin + \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. - The plugins' delayedInitialize() methods are called after the application is already running, + The plugins' delayedInitialize() functions are called after the application is already running, with a few milliseconds delay to application startup, and between individual delayedInitialize - method calls. To avoid unnecessary delays, a plugin should return true from the method if it + 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. - This method can be used if a plugin needs to do non-trivial setup that doesn't + This function can be used if a plugin needs to do non-trivial setup that doesn't necessarily needs to be done directly at startup, but still should be done within a short time afterwards. This can increase the felt plugin/application startup time a lot, with very little effort. @@ -139,16 +139,16 @@ \brief Called during a shutdown sequence in the same order as initialization before the plugins get deleted in reverse order. - This method should be used to disconnect from other plugins, + This function should be used to disconnect from other plugins, hide all UI, and optimize shutdown in general. If a plugin needs to delay the real shutdown for a while, for example if it needs to wait for external processes to finish for a clean shutdown, - the plugin can return IPlugin::AsynchronousShutdown from this method. This + 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 the asynchronousShutdownFinished() signal. - The default implementation of this method does nothing and returns + The default implementation of this function does nothing and returns IPlugin::SynchronousShutdown. Returns IPlugin::AsynchronousShutdown if the plugin needs to perform @@ -160,7 +160,7 @@ /*! \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 method of plugins is called in the running instance. + is running, this function of plugins is called in the running instance. Plugin-specific arguments are passed in \a options, while the rest of the arguments are passed in \a arguments. @@ -215,7 +215,7 @@ PluginSpec *IPlugin::pluginSpec() const /*! \fn void IPlugin::addObject(QObject *obj) - Convenience method that registers \a obj in the plugin manager's + Convenience function that registers \a obj in the plugin manager's plugin pool by just calling PluginManager::addObject(). */ void IPlugin::addObject(QObject *obj) @@ -225,7 +225,7 @@ void IPlugin::addObject(QObject *obj) /*! \fn void IPlugin::addAutoReleasedObject(QObject *obj) - Convenience method for registering \a obj in the plugin manager's + Convenience function for registering \a obj in the plugin manager's plugin pool. Usually, registered objects must be removed from the object pool and deleted by hand. Objects added to the pool via addAutoReleasedObject are automatically @@ -241,7 +241,7 @@ void IPlugin::addAutoReleasedObject(QObject *obj) /*! \fn void IPlugin::removeObject(QObject *obj) - Convenience method that unregisters \a obj from the plugin manager's + Convenience function that unregisters \a obj from the plugin manager's plugin pool by just calling PluginManager::removeObject(). */ void IPlugin::removeObject(QObject *obj) diff --git a/src/libs/extensionsystem/pluginerrorview.cpp b/src/libs/extensionsystem/pluginerrorview.cpp index d5c4fe7f568..e90cf11d83e 100644 --- a/src/libs/extensionsystem/pluginerrorview.cpp +++ b/src/libs/extensionsystem/pluginerrorview.cpp @@ -91,7 +91,7 @@ void PluginErrorView::update(PluginSpec *spec) break; case PluginSpec::Initialized: text = tr("Initialized"); - tooltip = tr("Plugin's initialization method succeeded"); + tooltip = tr("Plugin's initialization function succeeded"); break; case PluginSpec::Running: text = tr("Running"); diff --git a/src/libs/extensionsystem/pluginmanager.cpp b/src/libs/extensionsystem/pluginmanager.cpp index c7ce379b167..2de78a7f137 100644 --- a/src/libs/extensionsystem/pluginmanager.cpp +++ b/src/libs/extensionsystem/pluginmanager.cpp @@ -108,8 +108,8 @@ enum { debugLeaks = 0 }; Plugins (and everybody else) can add objects to a common 'pool' that is located in the plugin manager. Objects in the pool must derive from QObject, there are no other prerequisites. All objects of a specified type can be retrieved from the object pool - via the getObjects() and getObject() methods. They are aware of Aggregation::Aggregate, i.e. - these methods use the Aggregation::query methods instead of a qobject_cast to determine + via the getObjects() and getObject() functions. They are aware of Aggregation::Aggregate, i.e. + these functions use the Aggregation::query functions instead of a qobject_cast to determine the matching objects. Whenever the state of the object pool changes a corresponding signal is emitted by the plugin manager. @@ -134,7 +134,7 @@ enum { debugLeaks = 0 }; object in the pool. This approach does neither require the "user" plugin being linked against the "provider" plugin nor a common shared header file. The exposed interface is implicitly given by the - invokable methods of the "provider" object in the object pool. + invokable functions of the "provider" object in the object pool. The \c{ExtensionSystem::invoke} function template encapsulates {ExtensionSystem::Invoker} construction for the common case where @@ -220,11 +220,11 @@ enum { debugLeaks = 0 }; Retrieves the object of a given type from the object pool. - This method is aware of Aggregation::Aggregate. That is, it uses - the \c Aggregation::query methods instead of \c qobject_cast to + This function is aware of Aggregation::Aggregate. That is, it uses + the \c Aggregation::query functions instead of \c qobject_cast to determine the type of an object. If there are more than one object of the given type in - the object pool, this method will choose an arbitrary one of them. + the object pool, this function will choose an arbitrary one of them. \sa addObject() */ @@ -234,8 +234,8 @@ enum { debugLeaks = 0 }; Retrieves all objects of a given type from the object pool. - This method is aware of Aggregation::Aggregate. That is, it uses - the \c Aggregation::query methods instead of \c qobject_cast to + This function is aware of Aggregation::Aggregate. That is, it uses + the \c Aggregation::query functions instead of \c qobject_cast to determine the type of an object. \sa addObject() @@ -570,7 +570,7 @@ void PluginManager::remoteArguments(const QString &serializedArgument, QObject * Application options always override any plugin's options. \a foundAppOptions is set to pairs of ("option string", "argument") for any application options that were found. - The command line options that were not processed can be retrieved via the arguments() method. + The command line options that were not processed can be retrieved via the arguments() function. If an error occurred (like missing argument for an option that requires one), \a errorString contains a descriptive message of the error. @@ -675,7 +675,7 @@ void PluginManager::startTests() if (!pluginSpec->plugin()) continue; - // Collect all test functions/methods of the plugin. + // Collect all test functions of the plugin. QStringList allTestFunctions; const QMetaObject *metaObject = pluginSpec->plugin()->metaObject(); diff --git a/src/libs/extensionsystem/pluginspec.cpp b/src/libs/extensionsystem/pluginspec.cpp index 1f6c8f8acda..dff461984e2 100644 --- a/src/libs/extensionsystem/pluginspec.cpp +++ b/src/libs/extensionsystem/pluginspec.cpp @@ -128,19 +128,19 @@ information is available via the PluginSpec. \value Resolved The dependencies given in the description file have been - successfully found, and are available via the dependencySpecs() method. + successfully found, and are available via the dependencySpecs() function. \value Loaded The plugin's library is loaded and the plugin instance created (available through plugin()). \value Initialized - The plugin instance's IPlugin::initialize() method has been called + The plugin instance's IPlugin::initialize() function has been called and returned a success value. \value Running The plugin's dependencies are successfully initialized and extensionsInitialized has been called. The loading process is complete. \value Stopped - The plugin has been shut down, i.e. the plugin's IPlugin::aboutToShutdown() method has been called. + The plugin has been shut down, i.e. the plugin's IPlugin::aboutToShutdown() function has been called. \value Deleted The plugin instance has been deleted. */ |