1 files changed, 20 insertions, 3 deletions

diff --git a/libopie/todayplugininterface.h b/libopie/todayplugininterface.h
index 6ee2a06..29a12bc 100644
--- a/libopie/todayplugininterface.h
+++ b/libopie/todayplugininterface.h
@@ -13,9 +13,14 @@ class QWidget;
 #endif
 
 /**
  *
+ * A TodayPluginObject is the base for all Today Plugins.
+ * A plugin author needs to inherit this class and implement
+ * the pure virtual methods
  *
+ * @short base class for today plugins
+ * @author Maximilian Reiss
  *
  */
 class TodayPluginObject {
 
@@ -24,23 +29,30 @@ public:
     virtual ~TodayPluginObject() {};
 
     /**
      * The name if the plugin
+     * @return The plugin should return its name here
      */
     virtual QString pluginName() const = 0;
 
     /**
      * Version numbering
+     * @return The plugin should return the version number
      */
     virtual double versionNumber() const = 0;
 
 
+    /**
+     * @return the pixmap name widget?! -- FIXME
+     */
     virtual  QString pixmapNameWidget() const = 0;
 
-    /**    widget for the today view
+    /**
+     * widget for the today view
      * It _needs_ a parent here.
+     * Plugin authors need to take parent as parent!
      */
-    virtual QWidget* widget( QWidget * ) = 0;
+    virtual QWidget* widget( QWidget *parent ) = 0;
 
     /**
      * Pixmap used in the config widget
      */
@@ -48,13 +60,16 @@ public:
 
     /**
      * Config plugin widget - optional
      * If the plugin has a config widget, it  _needs_  a parent here.
+     * may return 0 if no config widget is needed
      */
     virtual TodayConfigWidget* configWidget( QWidget * ) = 0;
 
     /**
      * The application that should be assigned to the button (pixmap)
+     * Today will show the plugin icon. On click it tries to execute the
+     * plugin related application.
      */
     virtual QString appName() const = 0;
 
 
@@ -80,9 +95,11 @@ public:
     // virtual int maxHeight() const = 0;
 
 };
 
-
+/**
+ * This is part of the QCOM works. See example plugins how to do it right
+ */
 struct TodayPluginInterface : public QUnknownInterface {
     virtual TodayPluginObject *guiPart() = 0;
 };