aboutsummaryrefslogtreecommitdiffstats
path: root/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Mark example as highlighted (again)Kai Köhne2023-10-041-1/+1
| | | | | | | | | This broke with commit 46f44cb428e969e Pick-to: 6.5 6.6 6.6.0 Task-number: QTBUG-117210 Change-Id: I5447e1b753176881d3582d2ccbf6abd107b36601 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Update reference to 'Pure QML' exampleTopi Reinio2023-09-061-0/+3
| | | | | | | | | | | | | | | The 'Pure QML' example compositor in Qt Wayland has been renamed to 'Fancy Compositor'. Split the long snippet code line for starting the compositor for better readability. Mark the module clear of documentation warnings. Pick-to: 6.6 Change-Id: I6e07fa2f7a54820613760e98dd501821e0afb3b5 Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: I53d84dca3d82469b4401ffa463bddd29bdf8afe6 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove Cpp.ignoretokens, Cpp.ignoredirectives from .qdocconfKai Köhne2022-08-221-6/+0
| | | | | | | | qdoc's new clang backend does not use them anymore. Task-number: QTBUG-104903 Change-Id: Ib143c6e9ca9d9b9610822d79f16cf9a7f3bda23d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Make QtVirtualKeyboard project name match the includeKai Köhne2022-07-221-20/+20
| | | | | | | | | | | | Fixes (qdoc) Could not find the module header in include paths for module "QtVirtualKeyboardDoc" Pick-to: 6.4 Change-Id: Id0a8c81b1466ba60abc197293d609441772c7d04 Reviewed-by: Luca Di Sera <luca.disera@qt.io> Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Update documentationJarkko Koivikko2022-04-251-23/+22
| | | | | | | Task-number: QTBUG-100783 Change-Id: If48efba10aa9cfd856e54b0a8154c1a78389d5a9 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Migrate to autogenerated cpp exportsAlexey Edelev2021-11-031-1/+1
| | | | | | | | | | | Replace the hardcoded cpp exports with a generated one where it's applicable. Task-number: QTBUG-90492 Change-Id: I19c7b0b39aa2bd2acf58c67360f3ccb3c49fee1c Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
* Doc: Enforce zero documentation warnings in CITopi Reinio2021-11-021-0/+3
| | | | | | | | | Include the documentation build step in coin/module_config.yaml and set the documentation warning limit to zero. This prevents new documentation warnings from being introduced. Change-Id: I61bb2915a3ab17b81b344bc9ab7690462e7d9d56 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add a section for using the module with CMakeVenugopal Shivashankar2021-09-131-1/+1
| | | | | | | | | All the Qt module pages for C++ offer info. about using the module with CMake and qmake. Pick-to: 6.2 Change-Id: I0f9dcd76ef5e6da16102797af6b0eea058d62f3b Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-251-4/+0
| | | | | | Task-number: QTBUG-95987 Change-Id: I655653907c8454e6ef354879232cb7edceb7f628 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: I55517679621d72c39f483d9422738eb6d381dd6d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Fix documentation issuesTopi Reinio2019-01-041-5/+1
| | | | | | | | | | | This commit fixes multiple documentation warnings - typos, missing documentation, missing \internal specifiers, linking problems and incorrect documentation configuration which caused Clang to fail to build a precompiled header for QtVirtualKeyboard. Change-Id: I33baf730a98747842a7813bb6ea3a3545927410b Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Rename dependency to Qt Quick ControlsTopi Reinio2018-10-311-1/+1
| | | | | | | | | The documentation module for Qt Quick Controls 2 is now named simply 'qtquickcontrols'. Task-number: QTBUG-70333 Change-Id: Iba7d910c80f2c3f7fc919c64f94ca52114ec0d82 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Merge remote-tracking branch 'origin/5.11' into 5.12Qt Forward Merge Bot2018-10-021-0/+1
|\ | | | | | | Change-Id: Id4890b7444ab7d76e218ae0a82fb4f16619c2c89
| * Do show module license on all help pagesKai Koehne2018-09-271-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Qt Virtual Keyboard has a different main license than most other Qt modules, which is easy to miss. We do show the license on the module landing page and in the 'All modules' overview page, but if you directly open an example or a class page you can still miss this. This change adds the main license description to the header shared by all pages of the module; we (mis)use the buildversion variable for that, which was so far unused. Right now qdoc does not 'linkify' the entry. It could add a generic link to the landing page though, where the license is also described. Task-number: QTBUG-70354 Change-Id: I5f271b1bcba6992abfd1ad7e213fc5f2a93a0d25 Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Merge remote-tracking branch 'origin/5.11' into 5.12Liang Qi2018-08-301-1/+1
|\| | | | | | | | | | | | | | | Conflicts: src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf src/virtualkeyboard/platforminputcontext.cpp Change-Id: I3056b9cd19eb6c38fac1ad73eaac1945d816cc57
| * Doc: improve integration documentation, especially regarding WaylandMitch Curtis2018-08-231-1/+1
| | | | | | | | | | | | Change-Id: Id27ebb78001ff060d67917e9ac69f75682a885ac Reviewed-by: Johan Helsing <johan.helsing@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: Add C++ API for the extension pluginsJarkko Koivikko2018-08-061-16/+19
|/ | | | | | | | | | | | Needed for the new virtualkeyboard module, which will expose C++ interface to the virtual keyboard extension plugins. This change contains also some improvements to the existing documentation, mainly to the Techical Guide. Task-number: QTBUG-57602 Change-Id: I85194e205479deab0535f14867464b4d2ab15b89 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Resolve all documentation warningsTopi Reinio2018-03-071-0/+6
| | | | | | | | | | | QDoc in Qt 5.11 uses Clang to parse the C++ source for documentation. for this, Clang needs a module header which is not available for Qt Virtual Keyboard - construct a custom one for documentation builds and fix all remaining documentation warnings; \fn command syntax and one linking issue. Change-Id: I1e9b2170aca98782e9d6a758e84c9d17449cb25c Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Highlight the Qt Quick Virtual Keyboard exampleTopi Reinio2017-11-091-0/+3
| | | | | | | Task-number: QTBUG-60664 Change-Id: If27459f44dbd4c4c7f5f6d0d8d8826f3c7f5a030 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-11-261-7/+7
|\ | | | | | | | | | | | | Conflicts: src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf Change-Id: I2aac70f4bf65794c73096ec575c9f72bc63ec61c
| * Doc: Add dependency to Qt Reference DocumentationTopi Reinio2016-10-281-1/+1
| | | | | | | | | | | | | | Needed for generating the correct navigation and global linking. Change-Id: I84e8975e8e8abd6c77c9c75e0b3e6ca0eec623be Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Doc: Mark the remaining C++ API \internalLeena Miettinen2016-10-141-6/+6
| | | | | | | | | | | | | | | | | | | | - Hide the C++ classes entry from the help file (.qdocconf) - Remove link to the C++ classes from the module front page - Mark classes and namespace \internal - Mark the C++ module page \internal Change-Id: I07b04af84b45d048c5cbb133bd5d70f8b38f25dd Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Enable loading styles from multiple import pathsJeremy Katz2016-07-201-1/+1
|/ | | | | | | | | | | | | | | | Import was previously allowed from two locations: * qrc:/QtQuick/VirtualKeyboard/content/styles/ * The first import path containing QtQuick/VirtualKeyboard/Styles/ This prevents an application-supplied style outside of these locations from being used, even if the style name is unique. [ChangeLog] Added support for styles in any Qml import path under the directory QtQuick/VirtualKeyboard/Styles/<style> Change-Id: Ie6034709182f182efacb0317e49d095d51ced5a6 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-05-191-1/+1
|\ | | | | | | | | | | | | | | | | Conflicts: src/virtualkeyboard/lipisharedrecognizer.cpp src/virtualkeyboard/styles/styles.pro src/virtualkeyboard/virtualkeyboard.pro Change-Id: I150f2ad265f8a7bd07be1d9415cdad854e200e87
| * Doc: Remove repository name from examplesinstallpathTopi Reinio2016-05-131-1/+1
| | | | | | | | | | | | | | | | Examples in binary packages now directly match the install path. Task-number: QTBUG-52953 Change-Id: Ib0a413b8820473338e9b95443b41fcee0294fcff Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com>
* | Merge remote-tracking branch 'origin/5.6' into 5.7Liang Qi2016-04-211-2/+2
|\| | | | | | | | | | | | | | | Conflicts: examples/virtualkeyboard/basic/basic.pro src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf Change-Id: I92b07ae67779bba37141408e28c6f67e1731383a
| * Flatten example install path and directory structureMitch Curtis2016-04-201-5/+2
| | | | | | | | | | | | Change-Id: Ic270635b0c17578bc9f85cca2d9f3a7b49e33952 Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
* | Doc: Use a standard documentation config for a Qt moduleTopi Reinio2016-02-031-15/+7
|/ | | | | | | | | | | | - Rename index.html to qtvirtualkeyboard-index.html - Use the qt-module-defaults global doc template - Remove custom URL/version info - Use a namespace consistent with the rest of Qt modules - Update examplesinstallpath to the changes introduced in Qt 5.6 packaging. Change-Id: I83e920fb6dea3f303c901cd782f3f7223fe5c2a5 Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Fix version for the latest documentation (1.3 -> 2.0)Jarkko Koivikko2015-10-021-5/+5
| | | | | | Change-Id: I249217437a25f8b5b2579b579e4c9d64ce5f8e1c Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Add url= param to qdocconfKai Koehne2015-07-061-0/+1
| | | | | Change-Id: Ic9063478fc15dca7166c04972a2969d256cd9881 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Update version number to 1.3Jarkko Koivikko2015-02-261-5/+5
| | | | | | Change-Id: I030e6a29d7e862c575e658a87aa8c22a268cfedb Reviewed-by: Caroline Chao <caroline.chao@theqtcompany.com> Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
* Update version number to 1.2v1.2.0Jarkko Koivikko2014-09-041-5/+5
| | | | | Change-Id: I630901e9e7d8300043f896cfdf159160867ee349 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Increment API version to 1.1Jarkko Koivikko2014-06-251-5/+5
| | | | | | | | | | Make proper adjustments to documentation and qmldir files to remain backwards compatible with the applications still using the 1.0 version. Change-Id: I0a59065b09d4a0e60798629e98a0867c66b8dac8 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
* Move hunspell project into 3rdparty directoryJarkko Koivikko2014-06-161-1/+2
| | | | | Change-Id: Ic96fe15587f65606e94280173ddef49bb582344d Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Reimplement keyboard layout selectionJarkko Koivikko2014-05-061-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Moved keyboard layouts into locale specific directories and removed locale identifier from the layout file name. The FolderListModel now tracks the locale directories instead of layout file names. The default locale is now initialized based on current default locale (e.g. QLocale()). The locale selection also accepts partial locale names (e.g. language_*). The keyboard layout selection allows to override only those layout types that are different from the en_GB layout. For simple country variants such en_US only the specific layouts needs to be customized (e.g. symbols layout), while using default for the other layouts. The keyboard layout selection is now triggered manually in the Keyboard.qml instead of using bindings. With binding the keyboard layout could be changed multiple times before the final layout was found. There are now three kinds of numeric layouts, one for each exclusive numeric modes of the input method hints; digits, dialpad and numbers. The numbers layout is now dedicated for ImhFormattedNumbersOnly mode and it contains some extra math symbols. Added new parameter customLayoutsOnly for Keyboard.changeInputLanguage() function. When set to true, the list of possible languages is limited to those providing the specific layout type. Task number: QTRD-2823 Task number: QTRD-2898 Task number: QTRD-2899 Change-Id: I9b0e5cf4110a58313b7320af571aca899c55749c Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Fixes in qdocconfv1.0.0-tp1Caroline Chao2014-02-041-14/+14
| | | | | | | | | | | | | | - Don't make the Virtual Keyboard doc part of Qt's - Update path to examples - Add navigation pages - Give the project its own version - Add "standard" doc include - Make doc for DeclarativeInputContext internal - Move code snippets folder Change-Id: Ib46e27bd6dd70225583d75cf5567d65a11cfaa2e Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Fix documentation to list cpp classes and qml typesFrederik Gladhorn2014-01-281-6/+18
| | | | | Change-Id: Ic3528e5de45871818e105cde5ab6b5465db09623 Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Clean up virtual keyboard qdocconf a bitFrederik Gladhorn2014-01-281-30/+6
| | | | | | Change-Id: I5a9f49c15e4770a2896495a2142e86388ba9d710 Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
* Restructure and rename.Mitch Curtis2014-01-281-0/+68
This restructures the repo to match other Qt modules, like the Enterprise Controls. It also renames the plugin and usages of its name in the documentation so that the abbreviated "VKB" is not used anywhere. Change-Id: I5de3fc67846a50438e52f4be057abfa0d9be0d91 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>