aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2016-06-07 16:27:30 +0100
committerGiuseppe D'Angelo <giuseppe.dangelo@kdab.com>2016-06-07 20:29:46 +0000
commitcb8ce2bfaffc42aedeeaf5e68f7e5b481ba4c95b (patch)
tree8faa7bb2c64a0399520ccdd79ecd5e337ab8485f
parent6d54a59bd725ba83e758236c5ff0fc7855109dac (diff)
KeyNavigation: fix the documentation for its properties
It does not make any sense to document these properties with the same text, as qdoc will duplicate the text under the documentation of each and every property in the same documentation comment, resulting in weird documentation (such as the element you assign to "left" is the one you move to when you press the *right* key). Change-Id: Ic27502a5965cc2b8c61cfdaf887434d3c79256af Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/quick/items/qquickitem.cpp33
1 files changed, 28 insertions, 5 deletions
diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index e963f91961..d0f5f162fc 100644
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -414,21 +414,44 @@ void QQuickItemKeyFilter::componentComplete()
/*!
\qmlproperty Item QtQuick::KeyNavigation::left
+
+ This property holds the item to assign focus to
+ when the left cursor key is pressed.
+*/
+
+/*!
\qmlproperty Item QtQuick::KeyNavigation::right
+
+ This property holds the item to assign focus to
+ when the right cursor key is pressed.
+*/
+
+/*!
\qmlproperty Item QtQuick::KeyNavigation::up
+
+ This property holds the item to assign focus to
+ when the up cursor key is pressed.
+*/
+
+/*!
\qmlproperty Item QtQuick::KeyNavigation::down
- These properties hold the item to assign focus to
- when the left, right, up or down cursor keys
- are pressed.
+ This property holds the item to assign focus to
+ when the down cursor key is pressed.
*/
/*!
\qmlproperty Item QtQuick::KeyNavigation::tab
+
+ This property holds the item to assign focus to
+ when the Tab key is pressed.
+*/
+
+/*!
\qmlproperty Item QtQuick::KeyNavigation::backtab
- These properties hold the item to assign focus to
- when the Tab key or Shift+Tab key combination (Backtab) are pressed.
+ This property holds the item to assign focus to
+ when the Shift+Tab key combination (Backtab) is pressed.
*/
QQuickKeyNavigationAttached::QQuickKeyNavigationAttached(QObject *parent)