diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-08-23 15:12:03 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-09-06 07:22:31 +0000 |
commit | 57b15814c8865e517c43fe173c0ffcadf8557ade (patch) | |
tree | 35c238f57be475e69abd3e34baa32a136739dfd5 /src/imports/displaysettings/plugin.cpp | |
parent | 1812b8e95b8b27b0879c97e66fcda739b502f7aa (diff) |
Doc: Document QtDeviceUtilities
Added documentation for the following QML modules:
QtDeviceUtilities.BluetoothSettings
QtDeviceUtilities.DisplaySettings
QtDeviceUtilities.LocalDeviceSettings
QtDeviceUtilities.LocaleSettings
QtDeviceUtilities.NetworkSettings
QtDeviceUtilities.TimeDateSettings
QtDeviceUtilities.SettingsUI
And changed the name of this documentation module to
'Qt Device Utilities'.
Task-number: QTBUG-55320
Change-Id: Iee0d8467dccddc0ee75d7a395ae91f68b12ab9f2
Reviewed-by: Kimmo Ollila <kimmo.ollila@theqtcompany.com>
Diffstat (limited to 'src/imports/displaysettings/plugin.cpp')
-rw-r--r-- | src/imports/displaysettings/plugin.cpp | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/src/imports/displaysettings/plugin.cpp b/src/imports/displaysettings/plugin.cpp index a57b340..366ab0b 100644 --- a/src/imports/displaysettings/plugin.cpp +++ b/src/imports/displaysettings/plugin.cpp @@ -32,6 +32,58 @@ #include <qcoreapplication.h> #include "displaysettings.h" +/*! + \qmlmodule QtDeviceUtilities.DisplaySettings 1.0 + \title Qt Device Utilities: Display Settings + \ingroup qtee-qmlmodules + \brief Provides a singleton QML type for controlling display settings. + + Provides a singleton QML type for controlling display settings in an + embedded device. + + Import the module as follows: + + \badcode + import QtDeviceUtilities.DisplaySettings 1.0 + \endcode + + This will give you access to the singleton QML type DisplaySettings. + + \note Some functions may not be available on all of the platforms. + + \section1 QML Types +*/ + +/*! + \qmltype DisplaySettings + \inqmlmodule QtDeviceUtilities.DisplaySettings + \brief A singleton QML type for controlling display settings. + + There is no need to create an instance of this object. To use it, + simply import the \c {QtDeviceUtilities.DisplaySettings} module. +*/ + +/*! + \qmlproperty int DisplaySettings::displayBrightness + + Holds the display brightness (intensity of the backlight). A valid + range for the property is from 0 to 255, where 255 is the maximum + brightness and 0 is the minimum (typically, the backlight turned off). +*/ + +/*! + \qmlproperty int DisplaySettings::physicalScreenSizeInch + + Holds the physical (diagonal) screen size in inches. +*/ + +/*! + \qmlproperty bool DisplaySettings::physicalScreenSizeOverride + + Holds whether the value in physicalScreenSizeInch should be + used or not. +*/ + template <typename T> QObject *instance(QQmlEngine *engine, QJSEngine *) { T *t = new T(engine); |