diff options
| author | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-10-12 16:04:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@qt.io> | 2016-10-13 08:03:49 +0000 |
| commit | 1e073078a57c4ec83d111a11a240304af056d940 (patch) | |
| tree | df3dc2e5421b09d98b08e007b5b31086a5ee2ec9 /src/virtualkeyboard/virtualkeyboardsettings.cpp | |
| parent | 55bf7f17e19d644fe49b838d9c8f387b7e6b6251 (diff) | |
Doc: Use standard documentation structure for the module
- Link to separate QML types and C++ classes topics from front page
(instead of listing the types there)
- Turn the \page topic that lists all QML types into the \qmlmodule
topic for the module
- Add a \module topic to list C++ classes
- Add \ingroup, \title, and \brief commands to \qmlmodule topics
to display the docs correctly in tables
- Add standard content to \qmlmodule topics
- Remove unused \qmlmodule topics
- Fix \inmodule commands as necessary
Change-Id: I6f6538264fff2ad38994114a2fed7212495a18c2
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
Diffstat (limited to 'src/virtualkeyboard/virtualkeyboardsettings.cpp')
| -rw-r--r-- | src/virtualkeyboard/virtualkeyboardsettings.cpp | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/src/virtualkeyboard/virtualkeyboardsettings.cpp b/src/virtualkeyboard/virtualkeyboardsettings.cpp index 2fcbd23a..bbb16092 100644 --- a/src/virtualkeyboard/virtualkeyboardsettings.cpp +++ b/src/virtualkeyboard/virtualkeyboardsettings.cpp @@ -97,8 +97,17 @@ public: /*! \qmlmodule QtQuick.VirtualKeyboard.Settings 2.0 + \title Qt Quick Virtual Keyboard Settings QML Types + \ingroup qmlmodules - This module provides settings components for Qt Virtual Keyboard. + \brief Provides settings for Qt Virtual Keyboard. + + The QML types can be imported into your application using the following + import statements in your .qml file: + + \badcode + import QtQuick.VirtualKeyboard.Settings 2.0 + \endcode */ /*! |