diff options
author | Mitch Curtis <mitch.curtis@qt.io> | 2016-11-28 10:36:59 +0100 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@qt.io> | 2016-11-28 09:45:25 +0000 |
commit | cfa4ab4cbf13971d4b71ee920353822755a3bf31 (patch) | |
tree | f9cb0f44bb79f49a5683e88134aa7ce449305f59 | |
parent | 573fb399f9917713621d25e0c0aeb48fbc085af5 (diff) |
Improve the documentationv5.8.0-rc1v5.8.0
- Add some formatting to certain words
- Use shorter qdoc syntax alternatives
- Correct grammar
Change-Id: I405c11826b9f624f0b0305e44b2d6b2b390df3da
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
5 files changed, 27 insertions, 26 deletions
diff --git a/src/virtualkeyboard/content/HandwritingInputPanel.qml b/src/virtualkeyboard/content/HandwritingInputPanel.qml index 6492ab26..8582f721 100644 --- a/src/virtualkeyboard/content/HandwritingInputPanel.qml +++ b/src/virtualkeyboard/content/HandwritingInputPanel.qml @@ -42,23 +42,23 @@ import QtQuick.VirtualKeyboard 2.1 The HandwritingInputPanel is an add-on component for the InputPanel, which enables full-screen handwriting input for the application. - HandwritingInputPanel is designed to be anchored to full screen alongside + HandwritingInputPanel is designed to be anchored full screen alongside the InputPanel. The operating principle is that when the handwriting panel is "available", the InputPanel is invisible. This functionality is built-in, - and requires no more than a reference to InputPanel instance. + and requires no more than a reference to the InputPanel instance. - The panel is set into operation by setting the \l {HandwritingInputPanel::available} {HandwritingInputPanel.available} - property to true. When the panel is in operation, the keyboard remains hidden - when the input focus is set. When the available is true, handwriting input is - activated by setting the \l {HandwritingInputPanel::active} {HandwritingInputPanel.active} property to true. + The panel is set into operation by setting the \l {HandwritingInputPanel::}{available} + property to \c true. When the panel is in operation, the keyboard remains hidden + when the input focus is set. When \c available is \c true, handwriting input is + activated by setting the \l {HandwritingInputPanel::}{active} property to \c true. The user interface, which provides controls for handwriting mode and the - visibility of the keyboard, is application specific. One suggested implementation - is to use a floating button on the handwriting panel where single click toggles - the handwriting mode (changes the \l {HandwritingInputPanel::active} {active} property), and double-click toggles - the visibility of the keyboard (changes the \l {HandwritingInputPanel::available} {available} property). + visibility of the keyboard, is application-specific. One suggested implementation + is to use a floating button on the handwriting panel, where single click toggles + the handwriting mode (changes the \l {HandwritingInputPanel::}{active} property), and double-click toggles + the visibility of the keyboard (changes the \l {HandwritingInputPanel::}{available} property). - HandwritingInputPanel also provides word candidate popup which allows the user + HandwritingInputPanel also provides a word candidate popup which allows the user to select an alternative word candidate from the list of suggestions generated by the handwriting input method. */ @@ -74,15 +74,15 @@ Item { /*! This property controls the availability status of the handwriting input method. - Setting the property to true prepares the handwriting input method and inhibits + Setting the property to \c true prepares the handwriting input method and inhibits the display of keyboard. */ property bool available /*! This property controls the active status of the handwriting input method. - Setting the property to true activates the handwriting input method. When the - handwriting input method is active, all the touch input is captured by the + Setting the property to \c true activates the handwriting input method. When the + handwriting input method is active, all touch input is captured by the handwriting input panel and redirected to input engine for processing. */ property bool active diff --git a/src/virtualkeyboard/content/InputPanel.qml b/src/virtualkeyboard/content/InputPanel.qml index 2e500a1b..3e354471 100644 --- a/src/virtualkeyboard/content/InputPanel.qml +++ b/src/virtualkeyboard/content/InputPanel.qml @@ -38,9 +38,9 @@ import QtQuick.VirtualKeyboard 2.1 \ingroup qtvirtualkeyboard-qml The keyboard size is automatically calculated from the available - width, i.e. the keyboard maintains the aspect ratio specified by the current - style. Therefore the application should only set the \c width and \c y - coordinates of the InputPanel, and not the height. + width; that is, the keyboard maintains the aspect ratio specified by the current + style. Therefore the application should only set the \l {Item::}{width} and \l {Item::}{y} + coordinates of the InputPanel, and not the \l {Item::}{height}. */ Item { diff --git a/src/virtualkeyboard/content/components/TraceInputArea.qml b/src/virtualkeyboard/content/components/TraceInputArea.qml index 4d2b6e00..cdc4ecdd 100644 --- a/src/virtualkeyboard/content/components/TraceInputArea.qml +++ b/src/virtualkeyboard/content/components/TraceInputArea.qml @@ -42,8 +42,9 @@ import QtQuick.VirtualKeyboard 2.1 This type handles the trace interaction between the touch screen and the input engine. - The traces are rendered using the delegate from the current style - \l {KeyboardStyle::traceCanvasDelegate} {KeyboardStyle.traceCanvasDelegate}. + The traces are rendered using the delegate from the + \l {KeyboardStyle::}{traceCanvasDelegate} property of the current + \l KeyboardStyle. */ MultiPointTouchArea { @@ -59,7 +60,7 @@ MultiPointTouchArea { The rulers are defined as a number of pixels from the top edge of the boundingBox. - Here is an example how to define rulers: + Here is an example that demonstrates how to define rulers: \code horizontalRulers: [boundingBox.height / 3, boundingBox.height / 3 * 2] @@ -89,8 +90,8 @@ MultiPointTouchArea { /*! Canvas type of this trace input area. This property can be used to distinguish between different types of canvases. - For example, in full screen handwriting mode this property is set to "fullscreen", and - in keyboard handwriting mode this property is set to "keyboard". + For example, in full screen handwriting mode this property is set to \c "fullscreen", and + in keyboard handwriting mode this property is set to \c "keyboard". */ property string canvasType diff --git a/src/virtualkeyboard/content/components/TraceInputKey.qml b/src/virtualkeyboard/content/components/TraceInputKey.qml index 28740758..444208e9 100644 --- a/src/virtualkeyboard/content/components/TraceInputKey.qml +++ b/src/virtualkeyboard/content/components/TraceInputKey.qml @@ -65,7 +65,7 @@ Item { The rulers are defined as a number of pixels from the top edge of the bounding box. - Here is an example how to define rulers: + Here is an example that demonstrates how to define rulers: \code horizontalRulers: [boundingBox.height / 3, boundingBox.height / 3 * 2] @@ -90,7 +90,7 @@ Item { /*! Canvas type of this trace input area. This property can be used to distinguish between different types of canvases. - The default value is "keyboard". + The default value is \c "keyboard". */ property alias canvasType: traceInputArea.canvasType diff --git a/src/virtualkeyboard/styles/KeyboardStyle.qml b/src/virtualkeyboard/styles/KeyboardStyle.qml index 5e92aeb7..8c4dd153 100644 --- a/src/virtualkeyboard/styles/KeyboardStyle.qml +++ b/src/virtualkeyboard/styles/KeyboardStyle.qml @@ -39,7 +39,7 @@ import QtQuick 2.0 the InputPanel to decorate the virtual keyboard. The design size specifies the aspect ratio of the virtual keyboard. - Styles are scalable according to KeyboardStyle.scaleHint, which is + Styles are scalable according to \l scaleHint, which is calculated from the keyboard's actual height and design height. */ @@ -166,7 +166,7 @@ QtObject { /*! Template for the generic mode key. This template provides a visualization of the key in which the state - can be on / off. This template is used in situations where the key label + can be on or off. This template is used in situations where the key label will remain the same regardless of status. The current state is available in the \c control.mode property. |