Improve "Building Qt Virtual Keyboard" documentation.

Change-Id: Ie9ac370894f5b487d197e564f878b9951c037a64
Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>

1 files changed, 42 insertions, 23 deletions

diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc
index 602535b8..cfeba973 100644
--- a/src/virtualkeyboard/doc/src/build.qdoc
+++ b/src/virtualkeyboard/doc/src/build.qdoc
@@ -28,42 +28,61 @@
 This document describes how to build the Qt Virtual Keyboard plugin.
 
 The project is split into the following subprojects:
-- \e examples/quick/enterprise/virtualkeyboard/virtualkeyboard/virtualkeyboard.pro
-    Qt Virtual Keyboard Demo application
-- \e src/virtualkeyboard/virtualkeyboard.pro Qt Virtual Keyboard C++ backend
-    for input engine and QPlatformInputContext integration
-- \e src/virtualkeyboard/styles/styles.pro Qt Virtual Keyboard Style plugin
-    that enables style decorations for the keyboard
+\table
+\row
+    \li \e examples/quick/enterprise/virtualkeyboard/virtualkeyboard/virtualkeyboard.pro
+    \li Qt Virtual Keyboard Demo application
+\row
+    \li \e src/virtualkeyboard/virtualkeyboard.pro
+    \li Qt Virtual Keyboard C++ backend for input engine and
+        QPlatformInputContext integration
+\row
+    \li \e src/virtualkeyboard/styles/styles.pro
+    \li Qt Virtual Keyboard Style plugin that enables style decorations for the
+        keyboard
+\endtable
 
 The input methods are implemented either in C++ or QML.
-Qt Virtual Keyboard provides implementations of PlainInputMethod,
-MultitapInputMethod and HunspellInputMethod.
-The MultitapInputMethod is implemented in QML while the others are implemented
+Qt Virtual Keyboard provides implementations of \e PlainInputMethod,
+\e MultitapInputMethod and \e HunspellInputMethod.
+The \e MultitapInputMethod is implemented in QML while the others are implemented
 in C++.
 
-\section1 Build instructions
+\section1 Build Instructions
 
 The Qt Virtual Keyboard can be built for Linux Desktop/X11 or Boot2Qt targets.
 The target is automatically detected by QMAKE and requires no special
 configuration parameters.
 
-QtCreator is the preferred build environment for Qt Virtual Keyboard as you can
-then leverage the shadow build functionality and rapidly switch between build
-targets.
+Qt Creator is the preferred build environment for Qt Virtual Keyboard as you
+can then leverage the shadow build functionality and rapidly switch between
+build targets.
 
-\section2 Configuration options
+\section2 Configuration Options
 
-- \e CONFIG+=disable-xcb Disables X11 integration
-- \e CONFIG+=disable-hunspell Disables Hunspell integration
-- \e CONFIG+=retro-style Enables Retro style
+\table
+\row
+    \li \e CONFIG += disable-xcb
+    \li Disables X11 integration
+\row
+    \li \e CONFIG += disable-hunspell
+    \li Disables Hunspell integration
+\row
+    \li \e CONFIG += retro-style
+    \li Enables Retro style
+\endtable
 
-\section2 Extra targets
+\section2 Building Documentation
 
-- \e docs Generates documentation
+\table
+\row
+    \li \e {make docs}
+    \li Generates documentation
+\endtable
 
-\section2 Hunspell integration
+\section2 Hunspell Integration
 
-By default, HunspellInputMethod will not be available unless the Hunspell
+By default, \e HunspellInputMethod will not be available unless the Hunspell
 library and development headers are found. For Linux/X11 targets, the Hunspell
 library can be provided by installing the libhunspell-dev package.
 Alternatively, the Hunspell sources can be extracted into the
@@ -72,14 +91,14 @@ then the dictionary files must also be copied into the
 \e src/virtualkeyboard/hunspell/data directory. Furthermore, if Hunspell
 sources are used, \e hunspell.pro will be used for all targets.
 
-\section1 Deployment instructions
+\section1 Deployment
 
 \section2 Linux/X11
 
 Add a Deploy Step that executes the \e {make install} command, then deploy using
 the \e {Deploy All} command.
 
-\section2 Boot2Qt
+\section2 Boot to Qt
 
 Remount target file system as read-write before deployment.