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/localdevice/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/localdevice/plugin.cpp')
| -rw-r--r-- | src/imports/localdevice/plugin.cpp | 29 |
1 files changed, 8 insertions, 21 deletions
diff --git a/src/imports/localdevice/plugin.cpp b/src/imports/localdevice/plugin.cpp index 4ede971..ca9fe68 100644 --- a/src/imports/localdevice/plugin.cpp +++ b/src/imports/localdevice/plugin.cpp @@ -31,16 +31,9 @@ /*! \qmlmodule QtDeviceUtilities.LocalDeviceSettings 1.0 - \title Qt Local Device QML Module + \title Qt Device Utilities: Local Device Settings \ingroup qtee-qmlmodules - \brief A collection of the local device related utility functions, accessible from QML. -*/ - -/*! - \page b2qt-addon-utils.html - \title Qt Local Device Module - \ingroup qtee-modules - \brief A collection of the local device realted utility functions, accessible from QML. + \brief A collection of local device related utility functions. Provides utility functions for controlling an embedded device, such as device shutdown/reboot. @@ -53,33 +46,27 @@ This will give you access to the singleton QML type LocalDevice. - \note Some functions are currently only implemented for one of - the platforms. + \note Some functions may not be available on all of the platforms. \section1 QML Types - - \annotatedlist utils-qmltypes */ /*! \qmltype LocalDevice \inqmlmodule QtDeviceUtilities.LocalDeviceSettings - \ingroup utils-qmltypes \brief Singleton QML type providing access to utility functions. LocalDevice QML type is the interface to various utility functions. There is no need to create an instance of this object. To use it, - simply import the \c {LocalDevice} module: + simply import the \c QtDeviceUtilities.LocalDeviceSettings module: - \qml - QtDeviceUtilities.LocalDeviceSettings - - \endqml + \badcode + import QtDeviceUtilities.LocalDeviceSettings 1.0 + \endcode - \note Some functions are currently only implemented for one of - the platforms. + \note Some functions may not be available on all of the platforms. */ /*! |