add apidocs for the shellpluginloader

This commit is contained in:
Giorgos Tsiapaliokas 2013-08-31 17:47:11 +03:00 committed by Marco Martin
parent ff34152432
commit 9faa53540a

View File

@ -23,6 +23,28 @@
#include <Plasma/PluginLoader>
#include <plasmaview/plasmaview_export.h>
/**
* @class ShellPluginLoader plasmaview/shellpluginloader.h <PlasmaView/ShellPluginLoader>
*
* This class loads the shell package. Normally you won't need this class, unless if you
* want to use the PlasmaView::View and Plasma::Corona directly.
*
* This class must be instantiated before the Corona and the View
* example:
*
* <code>
* // example 1, it works
* Plasma::PluginLoader::setPluginLoader(new ShellPluginLoader);
* Plasma::Corona *corona = new Plasma::Corona();
* View *view = new View(corona);
*
* // exmaple 2, it doesn't work
* Plasma::corona *corona = new plasma::corona();
* View *view = new view(corona);
* Plasma::PluginLoader::setPluginLoader(new shellpluginloader);
* </code>
*/
class ShellPluginLoaderPrivate;
class PLASMAVIEW_EXPORT ShellPluginLoader : public Plasma::PluginLoader