[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    kdepim/kpilot/lib
From:       Adriaan de Groot <adridg () cs ! kun ! nl>
Date:       2003-06-15 10:33:23
[Download RAW message or body]

CVS commit by adridg: 

Added a little documentation


  M +14 -1     uiDialog.h   1.9


--- kdepim/kpilot/lib/uiDialog.h  #1.8:1.9
@@ -42,5 +42,12 @@ class UIDialog : public KDialogBase
 Q_OBJECT
 public:
-        UIDialog(QWidget *parent=0L, const char *name=0L,bool modal=false);
+        /**
+        * Create a UIDialog with the given parent and object name.
+        * The dialog can be made modal if you wish. The buttons
+        * can be specified using the second constructor, but you should
+        * always include an OK button for the purpose of committing
+        * whatever changes need to be made.
+        */
+        UIDialog(QWidget *parent=0L, const char *name=0L, bool modal=false);
         UIDialog(QWidget *parent=0L, const char *name=0L,
                 int buttonmask=Ok|Cancel, bool modal=false);
@@ -55,5 +62,11 @@ protected:
         */
         void addAboutPage(bool aboutbutton=false,KAboutData *data=0L);
+
 public:
+        /**
+        * This is the function that does the work of adding an about
+        * page to a tabwidget. It is made public and static so that
+        * it can be used elsewhere wherever tabwidgets appear.
+        */
         static QPushButton *addAboutPage(QTabWidget *,
                 KAboutData *data=0L,


[prev in list] [next in list] [prev in thread] [next in thread]