summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2017-09-05 11:32:52 +0200
committerJ-P Nurmi <jpnurmi@qt.io>2017-09-07 16:49:08 +0000
commitbc6e79ebab8f7556aa2c7cd4352ba24509bd4792 (patch)
tree3be5e0e7f11fdc8f82920b895269e69f62510c5d
parent4310e5fa1b942cb6216d9f700031fb8f7a412606 (diff)
Doc: Edit languagev5.10.0-alpha1
- Fixed pucntuation issues and typos - Removed redundant text Task-number: QTBUG-60647 Change-Id: I1ab0e8e62a2e3f4997629653b659f130c13db007 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc14
-rw-r--r--examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc6
-rw-r--r--examples/quickcontrols2/wearable/doc/src/qtquickcontrols2-wearable.qdoc53
3 files changed, 36 insertions, 37 deletions
diff --git a/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc b/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc
index 7e4dfce6..bc630bb8 100644
--- a/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc
+++ b/examples/quickcontrols2/sidepanel/doc/src/qtquickcontrols2-sidepanel.qdoc
@@ -29,10 +29,10 @@
\example sidepanel
\title Qt Quick Controls 2 - Side Panel
\ingroup qtquickcontrols2-examples
- \brief A non-closable persistent side panel with Drawer.
+ \brief A persistent side panel with Drawer.
- This example demonstrates how \l Drawer can be used as a non-closable
- persistent side panel.
+ This example demonstrates how \l Drawer can be used as a persistent side
+ panel.
\raw HTML
<div class="table"><table style="background:transparent; border:0px">
@@ -52,17 +52,17 @@
When the application is in portrait mode, the drawer is an interactive
side panel that can be swiped open from the left edge. It appears on
- top of the content, and blocks user interaction through its modal
+ top of the content, blocking user interaction through its modal
background. When the application is in landscape mode, the drawer and
- the content are laid out side by side.
+ the content are laid out side-by-side.
The current orientation of the application is determined by comparing
the width and height of the window:
\snippet sidepanel/sidepanel.qml orientation
- This is used to specify whether the drawer is \l {Popup::}{modal} and
- \l {Drawer::}{interactive}, and to configure its \l {Drawer::}{position}
+ This is used to determine whether the drawer should be \l {Popup::}{modal}
+ and \l {Drawer::}{interactive}, and to configure its \l {Drawer::}{position}
and \l {Popup::visible}{visibility} accordingly.
\quotefromfile sidepanel/sidepanel.qml
diff --git a/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc b/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc
index 095bd837..476667bb 100644
--- a/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc
+++ b/examples/quickcontrols2/swipetoremove/doc/src/qtquickcontrols2-swipetoremove.qdoc
@@ -29,10 +29,10 @@
\example swipetoremove
\title Qt Quick Controls 2 - Swipe to Remove
\ingroup qtquickcontrols2-examples
- \brief Demonstrates removing list items by swipe.
+ \brief Demonstrates removal of list items by swipe gesture.
This example demonstrates how \l SwipeDelegate can be used to implement
- removal of list items by swipe. This UI pattern is often used in touch
+ removal of list items by swiping. This UI pattern is often used in touch
user interfaces.
\image qtquickcontrols2-swipetoremove.png
@@ -46,7 +46,7 @@
The following snippet presents how the logic of removing items is
implemented. When the swipe is \l {SwipeDelegate::swipe}{completed}, it
- starts a timer tha waits a few seconds to let the user undo the remove
+ starts a timer that waits a few seconds to let the user undo the remove
action. Once the undo timer triggers, the item is removed from the list:
\snippet swipetoremove/swipetoremove.qml removal
diff --git a/examples/quickcontrols2/wearable/doc/src/qtquickcontrols2-wearable.qdoc b/examples/quickcontrols2/wearable/doc/src/qtquickcontrols2-wearable.qdoc
index b56b4c1d..7d4a6a23 100644
--- a/examples/quickcontrols2/wearable/doc/src/qtquickcontrols2-wearable.qdoc
+++ b/examples/quickcontrols2/wearable/doc/src/qtquickcontrols2-wearable.qdoc
@@ -38,7 +38,7 @@
\section1 Structure
- The main .qml file \c wearable.qml consists of an ApplicationWindow, a StackView
+ The main .qml file, \c wearable.qml, consists of an ApplicationWindow, a StackView
for a stack-based navigation model, and buttons for interactive navigation.
\quotefromfile wearable/wearable.qml
@@ -61,9 +61,9 @@
\section1 Styling
The demo uses a custom \l {Styling Qt Quick Controls 2}{Qt Quick Controls 2 style}
- embedded into the demo's resources. Since the style is specific to this particular
- demo, it only needs to implement a few controls. The style also provides a singleton
- type that contains various styling attributes, such as fonts and colors.
+ embedded into the demo's resources. The custom style is implemented for a
+ few controls only, as it is specific to this particular demo. It uses a
+ singleton type for various styling attributes, such as fonts and colors.
\list
\li \c qml/Style/PageIndicator.qml
@@ -83,10 +83,11 @@
\section1 Custom Type
- The demo application contains a custom button type implemented in \c qml/NaviButton.qml.
- The navigation button is used as a home and back button in \c wearable.qml. \c NaviButton
- extends the standard AbstractButton API with properties that control the slide in and slide
- out transitions and the button image.
+ The demo application contains a custom button type implemented in
+ \c qml/NaviButton.qml. The navigation button is used as a home and back
+ button in \c wearable.qml. \c NaviButton extends the AbstractButton type
+ with properties that control the slide in and slide out transitions and
+ the button image.
\quotefromfile wearable/qml/NaviButton.qml
\skipuntil import "Style"
@@ -100,10 +101,9 @@
\section1 Launcher Page
- The application launcher, which is specified as the initial content above, is
- implemented using a circular PathView in \c LauncherPage.qml. Each application is
- contained within its own .qml file, which is listed in a ListModel on the launcher
- page.
+ The application launcher is implemented using a circular PathView in
+ \c LauncherPage.qml. Each application is in a separate .qml file,
+ which is added to the ListModel on the launcher page.
\quotefromfile wearable/qml/LauncherPage.qml
\skipto PathView
@@ -133,29 +133,28 @@
applications, data acquisition is implemented using \l XMLHttpRequest to
read from local files. These files were generated by storing responses from
remote servers in JSON format. This code can be easily modified to acquire
- data from real remote servers.
+ data from remote servers.
\section2 Navigation
This application displays a walking route from source to destination. This
- route is obtained as a response by invoking an API provided by
- \l {https://www.openstreetmap.org/}. The response is in JSON format and the
- corresponding JavaScript file associated with the application helps interpret
- the response. Currently, it is not possible to specify the source and destination
- from within the application, but it can be easily added based on the device's
- capabilities. For example, user input could be implemented as screens with
- input fields, or can be communicated over Bluetooth/Wifi from a paired app
- running on another device such as a smart phone or PC.
+ route information is obtained using the REST API provided by
+ \l {https://www.openstreetmap.org/}. The API response is in JSON format, which
+ is parsed using JavaScript by the application. Currently, it is not possible
+ to specify the source and destination from within the application, but it can
+ be added based on the device's capabilities. For example, user input
+ could be implemented as screens with input fields, or can be communicated
+ over Bluetooth/Wifi from a paired application running on another device
+ such as a smart phone or PC.
\section2 Weather
This application displays weather information such as temperature, sunrise
and sunset times, air pressure, and so on. This information is obtained
- as a response to invoking \l {https://openweathermap.org/}. The response is
- in JSON format and the corresponding JavaScript file associated with the
- application helps interpret the response. As with the Navigation application,
- this application can be modified by adding screens to accept location information
- to obtain weather data for a given location.
+ from \l {https://openweathermap.org/} using its REST API. The API response is
+ in JSON format, which is parsed using JavaScript by the application. This
+ application can also be modified by adding screens to obtain weather data for
+ a given location.
\section2 World Clock
@@ -165,7 +164,7 @@
\section2 Others
- The remaining applications return static data for now, but they can easily be
+ The remaining applications return static data for now, but they can be
modified to process response data obtained from respective services.
\include examples-run.qdocinc