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

List:       kde-commits
Subject:    =?utf-8?q?=5Bakunambol=5D_library=3A_improve_documentation_very_?=
From:       Riccardo Iaconelli <riccardo () kde ! org>
Date:       2011-01-24 16:02:32
Message-ID: 20110124160232.BB233A6092 () git ! kde ! org
[Download RAW message or body]

Git commit 58a9ab1738da2467f405afc416bb3e79fdbb7004 by Riccardo Iaconelli.
Pushed by ruphy into branch 'master'.

improve documentation very much

Signed-off-by: Riccardo Iaconelli <riccardo@kde.org>

M  +14   -12   library/syncsource.h     

http://commits.kde.org/f8533119/58a9ab1738da2467f405afc416bb3e79fdbb7004

diff --git a/library/syncsource.h b/library/syncsource.h
index 03dd6c1..8428b9c 100644
--- a/library/syncsource.h
+++ b/library/syncsource.h
@@ -38,7 +38,7 @@ class KDE_EXPORT SyncSource2 : public QObject
         void setConfig(SyncConfig2 *c);
         SyncConfig2* config();
         
-        /*
+        /**
          * Returns the text that should be shown to the user in order to activate
          * this control.
          * 
@@ -46,34 +46,36 @@ class KDE_EXPORT SyncSource2 : public QObject
          */
         virtual QString controlText() = 0;
         
-        /*
+        /**
          * Sets the status of the source as "locked", aka a sync is in progress.
-         * Will deadlock if already locked.
+         * Will deadlock if already locked. Also see documentation from QMutex, which is used
+         * internally.
          */
         void lock();
-        /*
-         * Unlocks the source.
+        /**
+         * Unlocks the source, so that it can be reused. Unlocks the QMutex, internally.
          */
         void unlock();
-        /*
-         * Operates in the same way as you can see in the QMutex documentation.
+        /**
+         * Tries to lock the syncsource. Operates in the same way as you can see in
+         * the QMutex documentation.
          */
         bool tryLock();
         
-        /*
+        /**
          * Reimplement to provide a configuration interface to the user.
          */
         virtual QWidget* configurationInterface() = 0;
         
     public slots:
-        /*
+        /**
          * Triggers a sync. It will fail with a meaningful error if the source is already locked.
          */
         void triggerSync();
         
     protected:
     
-        /*
+       /**
         * This function is called when the user, or any other event, triggers a sync.
         * This should launch the sync until finished, and should use the signals to notify the UI.
         */
@@ -84,8 +86,8 @@ class KDE_EXPORT SyncSource2 : public QObject
         void error(QString);
         void success();
         
-        /*
-         * Internally used
+        /**
+         * Internally used.
          */
         void started();
         

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