diff options
author | Svetlana Abramenkova <sabramenkova@luxoft.com> | 2018-06-14 14:33:28 +0300 |
---|---|---|
committer | Dominik Holland <dominik.holland@pelagicore.com> | 2018-06-19 08:06:59 +0000 |
commit | a0f2af7fc25b49d082111f6c853e64188e6b4743 (patch) | |
tree | 6c16a65de2188a0d83531601fd3b3fcd1bb6b07b | |
parent | 448d7ce1e2cfad09dbe2de87d9cc9b1615bd92ff (diff) |
Update docs for release 5.11v5.11.1_QtAS
Fixed a few misspellings, referencies to the parent docs
Change-Id: Iafeeec9c09a08eaf03a071b80838b84ec653ffaf
Task-Id: AUTOSUITE-475
Reviewed-by: Ilya Gluschenko <IGluschenko@luxoft.com>
Reviewed-by: Nikita Krupitskas <nkrupitskas@luxoft.com>
-rw-r--r-- | doc/concepts.qdoc | 12 | ||||
-rw-r--r-- | doc/index.qdoc | 4 | ||||
-rw-r--r-- | doc/installation.qdoc | 11 | ||||
-rw-r--r-- | doc/qmllive-project.qdocconf | 3 | ||||
-rw-r--r-- | doc/usage.qdoc | 10 |
5 files changed, 20 insertions, 20 deletions
diff --git a/doc/concepts.qdoc b/doc/concepts.qdoc index 73e1634..b67e59c 100644 --- a/doc/concepts.qdoc +++ b/doc/concepts.qdoc @@ -34,7 +34,7 @@ \page qmllive-concepts.html \title Concepts -\chapter Live Reloading +\section1 Live Reloading During a typical user interface design phase, designers create many graphical documents describing the desired user interface. Transferring such graphical @@ -69,11 +69,11 @@ For a local session you only need the QmlLive Bench. It contains all of the required components in an easy-to-use interface. You type and save, we show you the outcome on your PC in a fraction of a second. This is ideally suited for a multi-monitor setup where you see your code on one display and the -the live results of your changes on the other display. Seamless user -interface creation is the target, where you see every change immediately. This +live results of your changes on the other display. Seamless user interface +creation is the target, where you see every change immediately. This is great for sketching out a scene or getting the last touch on animation behavior. It also encourages you to think in terms of components; instead of -developing a whole scene, you can can break apart the scene into smaller parts +developing a whole scene, you can break apart the scene into smaller parts or components. You can work on these small components and see how they look standalone or embedded into a larger scene. @@ -94,7 +94,7 @@ you can also connect more devices, or devices with different sizes. \image runtime.png -\chapter Display, Screens, Panels, Components, Fragments +\section1 Display, Screens, Panels, Components, Fragments \code +- Display @@ -131,7 +131,7 @@ and its screen navigation structure, and of the structure of individual screens their panels. It is also required to define a common set of components to be used inside the panels. The fragments are implementation-specific. -\chapter UX Sheets - \e{visual component testing} +\section1 UX Sheets - \e{visual component testing} UXSheet gives guidance on how to successfully develop user interface components with diff --git a/doc/index.qdoc b/doc/index.qdoc index c560534..b634978 100644 --- a/doc/index.qdoc +++ b/doc/index.qdoc @@ -36,7 +36,7 @@ \indexpage \title Qt QmlLive -\chapter Overview +\section1 Overview Qt QmlLive is a local and remote Qt Quick live reloading system. It allows you to change your QML user interface source code and view the result in almost @@ -58,7 +58,7 @@ your work so much more delightful. \endquotation -\chapter Contents +\section1 Contents The content of the documentation: diff --git a/doc/installation.qdoc b/doc/installation.qdoc index bf552b4..2fcb29e 100644 --- a/doc/installation.qdoc +++ b/doc/installation.qdoc @@ -34,15 +34,14 @@ \page qmllive-installation.html \title Installation -\chapter Dependencies +\section1 Dependencies \list \li Windows, Linux or macOS \li Qt5.4 or higher \endlist - -\chapter Building for desktop +\section1 Building for desktop \code $ qmake @@ -57,7 +56,7 @@ QmlLive Bench can be started directly from build directory by executing \endcode -\chapter Building for device +\section1 Building for device \e{Note: Only needed when you want to have live reloading enabled on the target.} @@ -78,7 +77,7 @@ Optionally it can be packaged with the help of \endcode -\chapter Building documentation +\section1 Building documentation \code $ qmake CONFIG+=force_independent @@ -88,7 +87,7 @@ Optionally it can be packaged with the help of The documentation will be available at \tt{doc/qmllive/index.html}. -\chapter Build options reference +\section1 Build options reference The following values can be added to qmake \c CONFIG variable: diff --git a/doc/qmllive-project.qdocconf b/doc/qmllive-project.qdocconf index 5744d9f..deab2e4 100644 --- a/doc/qmllive-project.qdocconf +++ b/doc/qmllive-project.qdocconf @@ -37,5 +37,6 @@ qhp.QmlLive.subprojects.manual.title = Qt QmlLive qhp.QmlLive.subprojects.manual.indexTitle = Qt QmlLive qhp.QmlLive.subprojects.manual.type = manual -navigation.homepage = "Qt QmlLive" +navigation.homepage = "Qt Automotive Suite" +navigation.landingpage = "Qt QmlLive" buildversion = "Qt QmlLive $QT_VERSION" diff --git a/doc/usage.qdoc b/doc/usage.qdoc index 3a669a6..35282fd 100644 --- a/doc/usage.qdoc +++ b/doc/usage.qdoc @@ -34,7 +34,7 @@ \page qmllive-usage.html \title Usage -\chapter Introduction +\section1 Introduction The QmlLive system was designed from the ground up to support your needs. It is structured in a modular fashion to be able to meet various usage @@ -52,7 +52,7 @@ For C++ developers, we also offer the ability to integrate the QmlLive system into your own custom runtime using our \l LiveNodeEngine class with a few lines of code and then use the QmlLive Bench to control it. -\chapter The Workbench +\section1 The Workbench The standard workbench is the all inclusive QML live reloading tool. It allows you to select a workspace to watch over and provides a default QML runtime for the @@ -79,7 +79,7 @@ options: -stayontop .........................keep viewer window on top \endcode -\chapter Qt Creator Integration +\section1 Qt Creator Integration You can integrate the QmlLive Bench into Qt Creator as an external tool. For this you need to open the Settings/Options dialog from Qt Creator and open the @@ -102,7 +102,7 @@ current project root folder open as workspace. -\chapter QmlLive Runtime +\section1 QmlLive Runtime A default runtime is provided by the QmlLive Runtime tool. It provides a default qml viewer and listens on a given port for IPC calls from @@ -149,7 +149,7 @@ this is used all workspace documents will be updated prior to instantiation of any QML component. -\chapter Custom Runtime +\section1 Custom Runtime You can create your own custom runtime with the QmlLive features. This allows you to use your QML view setup with your additional C++ code together with the QmlLive system. |