From 90b4d074ca2f8294d8fd6e51bb547b0fef3534aa Mon Sep 17 00:00:00 2001
From: Giorgos Tsiapaliwkas <terietor@gmail.com>
Date: Mon, 31 Oct 2011 06:47:17 +0200
Subject: [PATCH] Add some docu to ButtonRow and ButtonColumn

---
 .../plasmacomponents/qml/ButtonColumn.qml     | 55 ++++++++++--------
 .../plasmacomponents/qml/ButtonRow.qml        | 56 +++++++++++--------
 2 files changed, 65 insertions(+), 46 deletions(-)

diff --git a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml
index 752481c26..12f9dacc0 100644
--- a/declarativeimports/plasmacomponents/qml/ButtonColumn.qml
+++ b/declarativeimports/plasmacomponents/qml/ButtonColumn.qml
@@ -42,36 +42,45 @@
 import Qt 4.7
 import "ButtonGroup.js" as Behavior
 
-/*
-   Class: ButtonColumn
-   A ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well.
+/**Documentanted API
+Inherits:
+        Column
 
-   Note: This component don't support the enabled property.
-   If you need to disable it you should disable all the buttons inside it.
+Imports:
+        ButtonGroup.js
+        Qt 4.7
 
-   <code>
-       ButtonColumn {
-           Button { text: "Top" }
-           Button { text: "Bottom" }
-       }
-   </code>
-*/
+
+Description:
+        A ButtonColumn allows you to group Buttons in a column. It provides a selection-behavior as well.
+
+        Note: This component don't support the enabled property.
+        If you need to disable it you should disable all the buttons inside it.
+        TODO we need an example here...
+
+        This is an example,
+        <code>
+        ButtonColumn {
+            Button { text: "Top" }
+            Button { text: "Bottom" }
+            }
+        </code>
+
+Properties:
+        bool exclusive:
+        Specifies the grouping behavior. If enabled, the checked property on buttons contained
+        in the group will be exclusive.
+
+        Note that a button in an exclusive group will allways be checkable
+
+        Item checkedButton:
+        Returns the last checked button.
+**/
 Column {
     id: root
 
-    /*
-     * Property: exclusive
-     * [bool=true] Specifies the grouping behavior. If enabled, the checked property on buttons contained
-     * in the group will be exclusive.
-     *
-     * Note that a button in an exclusive group will allways be checkable
-     */
     property bool exclusive: true
 
-    /*
-     * Property: checkedButton
-     * [string] Contains the last checked Button.
-     */
     property Item checkedButton;
 
     Component.onCompleted: {
diff --git a/declarativeimports/plasmacomponents/qml/ButtonRow.qml b/declarativeimports/plasmacomponents/qml/ButtonRow.qml
index e88b015d4..b957e487a 100644
--- a/declarativeimports/plasmacomponents/qml/ButtonRow.qml
+++ b/declarativeimports/plasmacomponents/qml/ButtonRow.qml
@@ -42,36 +42,46 @@
 import QtQuick 1.1
 import "ButtonGroup.js" as Behavior
 
-/*
-   Class: ButtonRow
-   A ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well.
 
-   Note: This component don't support the enabled property.
-   If you need to disable it you should disable all the buttons inside it.
+/**Documentanted API
+ Inherits:
+ Row
 
-   <code>
-       ButtonRow {
-           Button { text: "Left" }
-           Button { text: "Right" }
-       }
-   </code>
-*/
+ Imports:
+ ButtonGroup.js
+ QtQuick 1.1
+
+
+ Description:
+        A ButtonRow allows you to group Buttons in a row. It provides a selection-behavior as well.
+
+        Note: This component don't support the enabled property.
+        If you need to disable it you should disable all the buttons inside it.
+ TODO we need an example here...
+
+        This is an example,
+        <code>
+        ButtonRow {
+            Button { text: "Left" }
+            Button { text: "Right" }
+            }
+        </code>
+
+Properties:
+     bool exclusive:
+     Specifies the grouping behavior. If enabled, the checked property on buttons contained
+     in the group will be exclusive.
+
+     Note that a button in an exclusive group will allways be checkable
+
+     Item checkedButton:
+     Returns the last checked button.
+     **/
 Row {
     id: root
 
-    /*
-     * Property: exclusive
-     * [bool=true] Specifies the grouping behavior. If enabled, the checked property on buttons contained
-     * in the group will be exclusive.
-     *
-     * Note that a button in an exclusive group will allways be checkable
-     */
     property bool exclusive: true
 
-    /*
-     * Property: checkedButton
-     * [string] Contains the last checked Button.
-     */
     property Item checkedButton;
 
     Component.onCompleted: {