1 files changed, 18 insertions, 0 deletions

diff --git a/libopie/todayconfigwidget.h b/libopie/todayconfigwidget.h
index 48cf379..6b49efc 100644
--- a/libopie/todayconfigwidget.h
+++ b/libopie/todayconfigwidget.h
@@ -5,2 +5,13 @@
 
+/**
+ * A base class for all Today Config Widgets.
+ * This will let a Today plugin to add the possibility of configuration.
+ * Plugins need to inherit from this class and need to implement
+ * the pure virtual method to control configuration.
+ * The Plugin should read its configuration during creation of the Widget
+ *
+ *
+ * @author Maximilian Reiß
+ * @short base class of all today config widgets
+ */
 class TodayConfigWidget : public QWidget {
@@ -10,2 +21,9 @@ public:
 
+    /**
+     * This will construct the widget. The widget gets deleted once the parent
+     * gets deleted as in any Qt application
+     *
+     * @param parent The parent of the widget
+     * @paran name The name of the object
+     */
     TodayConfigWidget( QWidget *parent,  const char *name ) : QWidget( parent,  name ) {} ;