From 93753a5b75541227fc9727c1e6c9f21826b4de83 Mon Sep 17 00:00:00 2001 From: Giorgos Tsiapaliwkas Date: Mon, 31 Oct 2011 06:49:21 +0200 Subject: [PATCH] Add some documentation to ProgressBar.qml --- .../plasmacomponents/qml/ProgressBar.qml | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/declarativeimports/plasmacomponents/qml/ProgressBar.qml b/declarativeimports/plasmacomponents/qml/ProgressBar.qml index efce6f20f..db887f61c 100644 --- a/declarativeimports/plasmacomponents/qml/ProgressBar.qml +++ b/declarativeimports/plasmacomponents/qml/ProgressBar.qml @@ -17,6 +17,38 @@ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ +/**Documentanted API + Inherits: + Item + + Imports: + QtQuick 1.0 + org.kde.plasma.core + +Description: + It is a simple progressBar which is using the plasma theme. + TODO Do we need more info? + +Properties: + alias minimumValue: + Sets the minimumValue for the progressBar + + alias maximumValue: + Sets the maximumValue for the progressBar + + alias value: + Returns the current value of the progressBar + + alias indeterminate: + TODO needs info + + int orientation: + Sets the orientation of the progressBar + + bool _isVertical: + Returns true if the progressBar is vertical. +**/ + import QtQuick 1.0 import org.kde.plasma.core 0.1 as PlasmaCore