From d096024f63829f1dcdb030108f7285db0e5d613d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Aur=C3=A9lien=20G=C3=A2teau?= <agateau@kde.org>
Date: Mon, 17 Dec 2012 21:39:55 +0100
Subject: [PATCH] Doxygenize ProgressBar

---
 .../plasmacomponents/qml/ProgressBar.qml      | 63 +++++++++----------
 1 file changed, 28 insertions(+), 35 deletions(-)

diff --git a/declarativeimports/plasmacomponents/qml/ProgressBar.qml b/declarativeimports/plasmacomponents/qml/ProgressBar.qml
index 9f65b1605..c3877cd4d 100644
--- a/declarativeimports/plasmacomponents/qml/ProgressBar.qml
+++ b/declarativeimports/plasmacomponents/qml/ProgressBar.qml
@@ -17,54 +17,47 @@
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
 
-/**Documented API
-        Inherits:
-        Item
-
-Imports:
-        QtQuick 1.0
-        org.kde.plasma.core
-
-Description:
-            It is a simple progressBar which is using the plasma theme.
-            Some operations take a period of time to be performed and the user needs a confirmation that the operation is still ongoing. If the user does not get any confirmation, they might suspect that they did something wrong or that the device has broken. A progress bar is one of available mechanisms for providing this reassurance to the user.
-
-Properties:
-          * real minimumValue:
-            Minimum Value for the progressBar
-
-          * real maximumValue:
-            Maximum value for the progressBar
-
-            real value:
-            Current value of the progressBar
-
-          * bool indeterminate:
-            Indicates whether the operation's duration is known or not. The property can have the following values:
-            true - the operation's duration is unknown, so the progress bar is animated. The value, minimum, and maximum properties are ignored.
-            false - the operation's duration is known, so the progress bar is drawn to indicate progress between the minimum and maximum values.
-            The default value is false.
-
-          * int orientation:
-            Orientation of the progressBar:
-            Qt.Horizontal or
-            Qt.Vertical
-**/
-
 import QtQuick 1.0
 import org.kde.plasma.core 0.1 as PlasmaCore
 import org.kde.qtextracomponents 0.1
 
+/**
+ * Simple progressBar using the plasma theme.
+ *
+ * Some operations take a period of time to be performed and the user needs a
+ * confirmation that the operation is still ongoing. If the user does not get
+ * any confirmation, they might suspect that they did something wrong or that
+ * the device has broken. A progress bar is one of the available mechanisms for
+ * providing this reassurance to the user.
+ */
 Item {
     id: progressBar
 
     // Common API
+    /** type:real Minimum value for the progressBar */
     property alias minimumValue: range.minimumValue
+    /** type:real Maximum value for the progressBar */
     property alias maximumValue: range.maximumValue
+    /** type:real Current value of the progressBar */
     property alias value: range.value
+    /**
+     * type:bool
+     * Indicates whether the operation's duration is known or not. The property
+     * can have the following values:
+     *
+     * - true: the operation's duration is unknown, so the progress bar is
+     *   animated. The value, minimum, and maximum properties are ignored.
+     * - false: the operation's duration is known, so the progress bar is drawn
+     *   to indicate progress between the minimum and maximum values.
+     *
+     * The default value is false.
+     */
     property alias indeterminate: indeterminateAnimation.running
 
     // Plasma API
+    /**
+     * Orientation of the progressBar: Qt.Horizontal or Qt.Vertical
+     */
     property int orientation: Qt.Horizontal
 
     width: 100
@@ -179,4 +172,4 @@ Item {
             }
         }
     }
-}
\ No newline at end of file
+}