Doc: supported environment variables

Change-Id: I2ad1767c1066a07a86e0f5889b350aa4500d685e
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>

7 files changed, 138 insertions, 49 deletions

diff --git a/src/imports/controls/doc/src/includes/qquickmaterialstyle.qdocinc b/src/imports/controls/doc/src/includes/qquickmaterialstyle.qdocinc
new file mode 100644
index 00000000..593e0588
--- /dev/null
+++ b/src/imports/controls/doc/src/includes/qquickmaterialstyle.qdocinc
@@ -0,0 +1,31 @@
+//! [env]
+\table
+    \header
+        \li Variable
+        \li Description
+    \row
+        \li \c QT_QUICK_CONTROLS_MATERIAL_THEME
+        \li Specifies the default \l {material-theme-attached-prop}{Material theme}.
+            The value can be one of the available themes, for example \c "Dark".
+    \row
+        \li \c QT_QUICK_CONTROLS_MATERIAL_ACCENT
+        \li Specifies the default \l {material-accent-attached-prop}{Material accent color}.
+            The value can be any \l {colorbasictypedocs}{color}, but it is recommended to use
+            one of the \l {pre-defined Material colors}, for example \c "Teal".
+    \row
+        \li \c QT_QUICK_CONTROLS_MATERIAL_PRIMARY
+        \li Specifies the default \l {material-primary-attached-prop}{Material primary color}.
+            The value can be any \l {colorbasictypedocs}{color}, but it is recommended to use
+            one of the \l {pre-defined Material colors}, for example \c "BlueGrey".
+    \row
+        \li \c QT_QUICK_CONTROLS_MATERIAL_FOREGROUND
+        \li Specifies the default \l {material-foreground-attached-prop}{Material foreground color}.
+            The value can be any \l {colorbasictypedocs}{color}, or one of the \l {pre-defined Material colors},
+            for example \c "Brown".
+    \row
+        \li \c QT_QUICK_CONTROLS_MATERIAL_BACKGROUND
+        \li Specifies the default \l {material-background-attached-prop}{Material background color}.
+            The value can be any \l {colorbasictypedocs}{color}, or one of the \l {pre-defined Material colors},
+            for example \c "Grey".
+\endtable
+//! [env]
diff --git a/src/imports/controls/doc/src/includes/qquickuniversalstyle.qdocinc b/src/imports/controls/doc/src/includes/qquickuniversalstyle.qdocinc
new file mode 100644
index 00000000..d3f4ad4f
--- /dev/null
+++ b/src/imports/controls/doc/src/includes/qquickuniversalstyle.qdocinc
@@ -0,0 +1,26 @@
+//! [env]
+\table
+    \header
+        \li Variable
+        \li Description
+    \row
+        \li \c QT_QUICK_CONTROLS_UNIVERSAL_THEME
+        \li Specifies the default \l {universal-theme-attached-prop}{Universal theme}.
+            The value can be one of the available themes, for example \c "Dark".
+    \row
+        \li \c QT_QUICK_CONTROLS_UNIVERSAL_ACCENT
+        \li Specifies the default \l {universal-accent-attached-prop}{Universal accent color}.
+            The value can be any \l {colorbasictypedocs}{color}, but it is recommended to use
+            one of the \l {pre-defined Universal colors}, for example \c "Violet".
+    \row
+        \li \c QT_QUICK_CONTROLS_UNIVERSAL_FOREGROUND
+        \li Specifies the default \l {universal-foreground-attached-prop}{Universal foreground color}.
+            The value can be any \l {colorbasictypedocs}{color}, or one of the \l {pre-defined Universal colors},
+            for example \c "Brown".
+    \row
+        \li \c QT_QUICK_CONTROLS_UNIVERSAL_BACKGROUND
+        \li Specifies the default \l {universal-background-attached-prop}{Universal background color}.
+            The value can be any \l {colorbasictypedocs}{color}, or one of the \l {pre-defined Universal colors},
+            for example \c "Steel".
+\endtable
+//! [env]
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-environment.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-environment.qdoc
new file mode 100644
index 00000000..9795471d
--- /dev/null
+++ b/src/imports/controls/doc/src/qtquickcontrols2-environment.qdoc
@@ -0,0 +1,65 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \page qtquickcontrols2-environment.html
+    \title Supported Environment Variables in Qt Quick Controls 2
+
+    This page contains a list of all environment variables that Qt Quick Controls 2
+    supports. The environment variables are primarily meant for testing purposes, but
+    they can also be used to set system-wide defaults.
+
+    \table
+        \header
+            \li Variable
+            \li Description
+        \row
+            \li \c QT_QUICK_CONTROLS_STYLE
+            \li Specifies the default \l {Styling Qt Quick Controls 2}{Qt Quick Controls 2 style}.
+                The value can be either one of the built-in styles, for example \c "Material",
+                or the path to a custom style such as \c ":/mystyle".
+        \row
+            \li \c QT_QUICK_CONTROLS_CONF
+            \li Specifies the location of the Qt Quick Controls 2 configuration file.
+                By default, the configuration file is loaded from the application's
+                resources in \c ":/qtquickcontrols2.conf".
+     \endtable
+
+    \l {Material style} specific environment variables:
+
+    \include qquickmaterialstyle.qdocinc env
+
+    \l {Universal style} specific environment variables:
+
+    \include qquickuniversalstyle.qdocinc env
+
+    \section1 Related Information
+
+    \list
+      \li \l{Styling Qt Quick Controls 2}
+    \endlist
+*/
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
index de3d0c37..23f1e7e5 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-index.qdoc
@@ -69,6 +69,7 @@
       \li \l{Using File Selectors with Qt Quick Controls 2}
       \li \l{Differences between Qt Quick Controls}
       \li \l{Deploying Qt Quick Controls 2 Applications}
+      \li \l{Supported Environment Variables in Qt Quick Controls 2}
     \endlist
 
     \section1 Reference
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
index c253bf72..187b51ea 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-material.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2015 The Qt Company Ltd.
+** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -118,31 +118,10 @@
 
     \section3 Environment Variables
 
-    \table
-        \header
-            \li Variable
-            \li Description
-        \row
-            \li \c QT_QUICK_CONTROLS_MATERIAL_THEME
-            \li The value can be one of the available \l {material-theme-attached-prop}{themes},
-                for example \c "Dark".
-        \row
-            \li \c QT_QUICK_CONTROLS_MATERIAL_ACCENT
-            \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
-                to use one of the \l {pre-defined Material colors}, for example \c "Teal".
-        \row
-            \li \c QT_QUICK_CONTROLS_MATERIAL_PRIMARY
-            \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
-                to use one of the \l {pre-defined Material colors}, for example \c "BlueGrey".
-        \row
-            \li \c QT_QUICK_CONTROLS_MATERIAL_FOREGROUND
-            \li The value can be any \l {colorbasictypedocs}{color}, or one of the
-                \l {pre-defined Material colors}.
-        \row
-            \li \c QT_QUICK_CONTROLS_MATERIAL_BACKGROUND
-            \li The value can be any \l {colorbasictypedocs}{color}, or one of the
-                \l {pre-defined Material colors}.
-    \endtable
+    \include qquickmaterialstyle.qdocinc env
+
+    See \l {Supported Environment Variables in Qt Quick Controls 2} for the full
+    list of supported environment variables.
 
     \section2 Dependency
 
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
index d63cbe69..2b44b50d 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-styles.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2015 The Qt Company Ltd.
+** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -126,6 +126,9 @@
     QT_QUICK_CONTROLS_STYLE=universal ./app
     \endcode
 
+    See \l {Supported Environment Variables in Qt Quick Controls 2} for the full list
+    of supported environment variables.
+
     \section2 Configuration file
     \target qtquickcontrols2-conf
 
@@ -183,5 +186,6 @@
     \li \l {Universal Style}
     \li \l{Using File Selectors with Qt Quick Controls 2}
     \li \l {Deploying Qt Quick Controls 2 Applications}
+    \li \l {Supported Environment Variables in Qt Quick Controls 2}
     \endlist
 */
diff --git a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
index b8f7789b..5ae99bef 100644
--- a/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
+++ b/src/imports/controls/doc/src/qtquickcontrols2-universal.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2015 The Qt Company Ltd.
+** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -117,27 +117,10 @@
 
     \section3 Environment Variables
 
-    \table
-        \header
-            \li Variable
-            \li Description
-        \row
-            \li \c QT_QUICK_CONTROLS_UNIVERSAL_THEME
-            \li The value can be one of the available \l {universal-theme-attached-prop}{themes},
-                for example \c "Dark".
-        \row
-            \li \c QT_QUICK_CONTROLS_UNIVERSAL_ACCENT
-            \li The value can be any \l {colorbasictypedocs}{color}, but it is recommended
-                to use one of the \l {pre-defined Universal colors}, for example \c "Violet".
-        \row
-            \li \c QT_QUICK_CONTROLS_UNIVERSAL_FOREGROUND
-            \li The value can be any \l {colorbasictypedocs}{color}, or one of the
-                \l {pre-defined Universal colors}.
-        \row
-            \li \c QT_QUICK_CONTROLS_UNIVERSAL_BACKGROUND
-            \li The value can be any \l {colorbasictypedocs}{color}, or one of the
-                \l {pre-defined Universal colors}.
-    \endtable
+    \include qquickuniversalstyle.qdocinc env
+
+    See \l {Supported Environment Variables in Qt Quick Controls 2} for the full
+    list of supported environment variables.
 
     \section2 Dependency