summaryrefslogtreecommitdiffstats
path: root/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2016-08-11 16:29:12 +0200
committerVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2016-08-17 12:17:18 +0000
commit8dddf4fff07fee0d5765143bab3c6f3ded2f0ac5 (patch)
tree160083382bd0f6f8fb5e41c8803d99a01a03ddef /src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
parent33ad940cddf0a9529f205fe645f1b1d76f6f04f1 (diff)
Doc: Language edits
Task-number: QTBUG-53147 Change-Id: I353cf18b9661b5eb2371072f8091dc890fc7fcf0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniƶ <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/compositor/doc/src/qtwaylandcompositor-overview.qdoc')
-rw-r--r--src/compositor/doc/src/qtwaylandcompositor-overview.qdoc34
1 files changed, 20 insertions, 14 deletions
diff --git a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
index 9811d5205..d2f0f6f40 100644
--- a/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
+++ b/src/compositor/doc/src/qtwaylandcompositor-overview.qdoc
@@ -30,25 +30,31 @@
\title Qt Wayland Compositor
\brief An API to develop display servers supporting the Wayland protocol
- Qt Wayland Compositor is a module consisting of QML and C++ APIs for developing
- custom display servers based on the \l{http://wayland.freedesktop.org}{Wayland protocol}.
- The server displays content from client applications that support the Wayland protocol.
+ Qt Wayland Compositor is a module that provides QML and C++ APIs for
+ developing custom display servers based on the
+ \l{http://wayland.freedesktop.org}{Wayland protocol}. The server displays
+ content from client applications that support the Wayland protocol.
\section1 Environment Variables and Command-line Arguments
- The Qt Wayland Compositor API recognizes some environment variables and command-line arguments
- that can be used to customize its behavior.
+ The Qt Wayland Compositor API recognizes some environment variables and
+ command-line arguments that can be used to customize its behavior.
- The environment variables:
\list
- \li QT_WAYLAND_HARDWARE_INTEGRATION Selects which hardware integration plugin to use.
- \li QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects which client buffer integration plugin to use.
- \li QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects which server integration plugin to use.
- \endlist
-
- The command-line arguments:
- \list
- \li --wayland-socket-name Overrides the default socket name used for communicating with clients.
+ \li Environment variables:
+ \list
+ \li \b QT_WAYLAND_HARDWARE_INTEGRATION Selects the hardware integration
+ plugin to use.
+ \li \b QT_WAYLAND_CLIENT_BUFFER_INTEGRATION Selects the client buffer
+ integration plugin to use.
+ \li \b QT_WAYLAND_SERVER_BUFFER_INTEGRATION Selects the server
+ integration plugin to use.
+ \endlist
+ \li Command-line arguments:
+ \list
+ \li \c{--wayland-socket-name} Overrides the default socket name used for
+ communicating with clients.
+ \endlist
\endlist
\section1 Examples