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

List:       kde-commits
Subject:    kdelibs/kutils
From:       John Ratke <jratke () comcast ! net>
Date:       2004-05-31 21:30:24
Message-ID: 20040531213024.F271E126E9 () office ! kde ! org
[Download RAW message or body]

CVS commit by jratke: 


Documentation update to explain how "Help" button works on KCMultiDialog.


  M +12 -8     kcmultidialog.h   1.32


--- kdelibs/kutils/kcmultidialog.h  #1.31:1.32
@@ -171,5 +171,5 @@ signals:
 protected slots:
     /**
-     * This slot is called when the user presses the "Default" Button
+     * This slot is called when the user presses the "Default" Button.
      * You can reimplement it if needed.
      *
@@ -179,5 +179,5 @@ protected slots:
 
     /**
-     * This slot is called when the user presses the "Reset" Button
+     * This slot is called when the user presses the "Reset" Button.
      * You can reimplement it if needed.
      *
@@ -187,6 +187,6 @@ protected slots:
 
     /**
-     * This slot is called when the user presses the "Apply" Button
-     * You can reimplement it if needed
+     * This slot is called when the user presses the "Apply" Button.
+     * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation!
@@ -195,6 +195,6 @@ protected slots:
 
     /**
-     * This slot is called when the user presses the "OK" Button
-     * You can reimplement it if needed
+     * This slot is called when the user presses the "OK" Button.
+     * You can reimplement it if needed.
      *
      * @note Make sure you call the original implementation!
@@ -203,6 +203,10 @@ protected slots:
 
     /**
-     * This slot is called when the user presses the "Help" Button
-     * You can reimplement it if needed
+     * This slot is called when the user presses the "Help" Button.
+     * It reads the DocPath field of the currently selected KControl
+     * module's .desktop file to find the path to the documentation,
+     * which it then attempts to load.
+     * 
+     * You can reimplement this slot it if needed.
      *
      * @note Make sure you call the original implementation!


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