From 22c18e2d1ea15ffed34efe564f76d8d87cee4d2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20G=C3=A2teau?= Date: Fri, 14 Dec 2012 16:57:48 +0100 Subject: [PATCH] Doxygenize ButtonRow --- .../plasmacomponents/qml/ButtonRow.qml | 59 ++++++++----------- 1 file changed, 25 insertions(+), 34 deletions(-) diff --git a/declarativeimports/plasmacomponents/qml/ButtonRow.qml b/declarativeimports/plasmacomponents/qml/ButtonRow.qml index 17191e220..1921f9cc4 100644 --- a/declarativeimports/plasmacomponents/qml/ButtonRow.qml +++ b/declarativeimports/plasmacomponents/qml/ButtonRow.qml @@ -39,48 +39,39 @@ ** ****************************************************************************/ -/**Documented API -Inherits: - Row - -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. - - This is an example, - - ButtonRow { - Button { text: "Left" } - Button { text: "Right" } - } - - -Properties: - bool exclusive: - Specifies the grouping behavior. If enabled, the checked property on buttons contained - in the group will be exclusive.The default value is true. - - Note that a button in an exclusive group will allways be checkable - - Item checkedButton: - Returns the last checked button. - **/ - import QtQuick 1.1 import "ButtonGroup.js" as Behavior +/** + * A ButtonRow allows you to group Buttons in a row. It provides a + * selection-behavior as well. + * + * Note: This component does not support the enabled property. If you need to + * disable it you should disable all the buttons inside it. + * + * Example code: + * + * @code + * ButtonRow { + * Button { text: "Left" } + * Button { text: "Right" } + * } + * @endcode + */ Row { id: root + /** + * Specifies the grouping behavior. If enabled, the checked property on + * buttons contained in the group will be exclusive.The default value is true. + * + * Note that a button in an exclusive group will always be checkable + */ property bool exclusive: true + /** + * Returns the last checked button + */ property Item checkedButton; Component.onCompleted: {