Docs: SwipeView

Change-Id: Iabeb3ebc54f64d2f3d0b008a5f5a16a89f701f85
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Liang Qi <liang.qi@theqtcompany.com>

1 files changed, 19 insertions, 1 deletions

diff --git a/src/templates/qquickswipeview.cpp b/src/templates/qquickswipeview.cpp
index bc48a170..2163ba61 100644
--- a/src/templates/qquickswipeview.cpp
+++ b/src/templates/qquickswipeview.cpp
@@ -48,7 +48,25 @@ QT_BEGIN_NAMESPACE
     \ingroup navigation
     \brief A swipe view control.
 
-    TODO
+    SwipeView provides a swipe-based navigation model.
+
+    \image qtlabscontrols-swipeview-wireframe.png
+
+    SwipeView is populated with a set of pages. One page is visible at a time.
+    The user can navigate between the pages by swiping sideways. Notice that
+    SwipeView itself is entirely non-visual. It is recommended to combine it
+    with PageIndicator, to give the user a visual clue that there are multiple
+    pages.
+
+    \snippet qtlabscontrols-swipeview-indicator.qml 1
+
+    As shown above, SwipeView is typically populated with a static set of
+    pages that are defined inline as children of the view. It is also possible
+    to \l {Container::addItem()}{add}, \l {Container::insertItem()}{insert},
+    \l {Container::moveItem()}{move}, and \l {Container::removeItem()}{remove}
+    pages dynamically at run time.
+
+    \sa TabBar, PageIndicator, {Customizing SwipeView}
 */
 
 class QQuickSwipeViewPrivate : public QQuickContainerPrivate