summaryrefslogtreecommitdiffstats
path: root/src/declarative/qml/qdeclarativeextensionplugin.cpp
diff options
context:
space:
mode:
authorMichael Brasser <michael.brasser@nokia.com>2010-04-16 04:54:19 (GMT)
committerMichael Brasser <michael.brasser@nokia.com>2010-04-16 05:09:29 (GMT)
commitba3f33401c97c5517abe19f4ea6f6307e4374c6c (patch)
tree0f5b75c49676e84bd48ff1ebeaae37662cf67634 /src/declarative/qml/qdeclarativeextensionplugin.cpp
parent8693ed5a3fd0814802613c5a8a78b6802751bd0f (diff)
downloadQt-ba3f33401c97c5517abe19f4ea6f6307e4374c6c.zip
Qt-ba3f33401c97c5517abe19f4ea6f6307e4374c6c.tar.gz
Qt-ba3f33401c97c5517abe19f4ea6f6307e4374c6c.tar.bz2
More class documentation fixes for declarative.
Diffstat (limited to 'src/declarative/qml/qdeclarativeextensionplugin.cpp')
-rw-r--r--src/declarative/qml/qdeclarativeextensionplugin.cpp11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/declarative/qml/qdeclarativeextensionplugin.cpp b/src/declarative/qml/qdeclarativeextensionplugin.cpp
index 762c642d..863bfc4 100644
--- a/src/declarative/qml/qdeclarativeextensionplugin.cpp
+++ b/src/declarative/qml/qdeclarativeextensionplugin.cpp
@@ -59,6 +59,11 @@ QT_BEGIN_NAMESPACE
function, and exporting the class using the Q_EXPORT_PLUGIN2()
macro.
+ QML extension plugins can be used to provide either application-specific or
+ library-like plugins. Library plugins should limit themselves to registering types,
+ as any manipulation of the engine's root context may cause conflicts
+ or other issues in the library user's code.
+
See \l {Extending QML in C++} for details how to write a QML extension plugin.
See \l {How to Create Qt Plugins} for general Qt plugin documentation.
@@ -85,7 +90,7 @@ QDeclarativeExtensionPlugin::QDeclarativeExtensionPlugin(QObject *parent)
}
/*!
- Destructor.
+ Destroys the plugin.
*/
QDeclarativeExtensionPlugin::~QDeclarativeExtensionPlugin()
{
@@ -94,7 +99,9 @@ QDeclarativeExtensionPlugin::~QDeclarativeExtensionPlugin()
/*!
\fn void QDeclarativeExtensionPlugin::initializeEngine(QDeclarativeEngine *engine, const char *uri)
- Initializes the extension from the \a uri using the \a engine.
+ Initializes the extension from the \a uri using the \a engine. Here an application
+ plugin might, for example, expose some data or objects to QML,
+ as context properties on the engine's root context.
*/
void QDeclarativeExtensionPlugin::initializeEngine(QDeclarativeEngine *engine, const char *uri)