Add documentation for PluginTypes

src/libsnore/hint.h

@@ -35,6 +35,8 @@ namespace Snore
 /**
  * Hint contains extra information accesible by key.
  * The keys are case sensitive.
+ *
+ * @author Patrick von Reth \<vonreth at kde.org\>
  */
 
 class SNORE_EXPORT Hint

src/libsnore/plugins/plugincontainer.h

@@ -30,7 +30,7 @@ class PluginContainer;
 
 typedef  QHash<QString, PluginContainer *> PluginContaienrHash;
 
-class SNORE_EXPORT PluginContainer
+class PluginContainer
 {
 public:
     static const QHash<QString, PluginContainer *> pluginCache(SnorePlugin::PluginTypes type);

src/libsnore/plugins/plugins.h

@@ -30,16 +30,50 @@ namespace Snore
 
 class PluginContainer;
 
+/**
+ *  SnorePlugin represents the base class for the plugins.
+ *
+ * @author Patrick von Reth \<vonreth at kde.org\>
+ */
+
 class SNORE_EXPORT SnorePlugin : public QObject
 {
     Q_OBJECT
 public:
+    /**
+     * The PluginType Flags.
+     */
     enum PluginType {
+        /**
+         * Flag for loading no plugins.
+         */
         NONE                = 0,
+
+        /**
+         * Backends are those plugins that are capable of reporting user interaction.
+         */
         BACKEND             = 1 << 0,
+
+        /**
+         * Secondary backaends are non interactive.
+         * Redirection or playback of a sound file.
+         */
         SECONDARY_BACKEND   = 1 << 1,
+
+        /**
+         * Frontends are capable of recieving notifications.
+         */
         FRONTEND            = 1 << 2,
+
+        /**
+         * Generell plugins, currently there are not plugins implemented.
+         */
         PLUGIN              = 1 << 3,
+
+
+        /**
+         * Flag for loading all plugins.
+         */
         ALL                 = ~0
     };