Jumbo API documentation update

and some API fixed
ColorDialog is now OColorDialog!!! keep the namespace tidy!
ColorPopupMenu is now OColorPopupMenu!!! keep the namespace tidy
ColorDialog TT couldn't break bc we can so make it const QColor&
OTimePicker add some convience methods

more I might have forgot

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
@@ -16,3 +16,8 @@ class QWidget;
  *
+ * 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
  *
@@ -27,2 +32,3 @@ public:
      * The name if the plugin
+     * @return The plugin should return its name here
      */
@@ -32,2 +38,3 @@ public:
      * Version numbering
+     * @return The plugin should return the version number
      */
@@ -36,8 +43,13 @@ public:
 
+    /**
+     * @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;
 
@@ -51,2 +63,3 @@ public:
      * If the plugin has a config widget, it  _needs_  a parent here.
+     * may return 0 if no config widget is needed
      */
@@ -56,2 +69,4 @@ public:
      * 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.
      */
@@ -83,3 +98,5 @@ public:
 
-
+/**
+ * This is part of the QCOM works. See example plugins how to do it right
+ */
 struct TodayPluginInterface : public QUnknownInterface {