summaryrefslogtreecommitdiffstats
path: root/src/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix documentation issuesTopi Reinio2022-06-151-1/+2
| | | | | | | | | | | Add unversioned project name as a \keyword. This fixes a number of links to "Qt Device Utilities". Fix a number of typos and other minor issues. Pick-to: 6.4 6.3 Change-Id: I0c1ed8812b2c360181189a22afd022df51bb21e7 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Docs: Update SettingUI git link pathNicholas Bennett2022-06-131-1/+2
| | | | | | | | | | The code location was moved to the examples folder, have updated the link path to match. Fixes: QTBUG-104115 Pick-to: 6.3 6.4 Change-Id: I69ab649fd389dd348212dbaeaed7f6df61cd2392 Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
* Docs: Remove device creation license informationNicholas Bennett2022-05-092-6/+2
| | | | | | | | | | | | | | | What commercial package a module is currently a part of should not be included in the technical documentation. That information is available here: https://www.qt.io/product/features Updated landing page. Removed an obsolete link. Pick-to: 6.3 6.2 Change-Id: I977f07d54cdc454c07e16cadbb8ae1d2e8202a20 Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
* Doc: Fix CMake build configuration for doc buildsTopi Reinio2021-12-166-19/+29
| | | | | | | | | | | * Add src/doc into the build * Select the correct doc template for online doc builds * Move and update the online sidebar * Fix q QDoc warning in passing Pick-to: 6.3 6.2 Change-Id: Ib40e5e05de337da59b69ce950edf2e9e041af536 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Docs: Revert c5aa5c partiallyNicholas Bennett2021-12-161-1/+1
| | | | | | | | Reverted the change to the default-module.qdocconf include. Pick-to: 6.2 6.3 Change-Id: I80501abc4dcd20f13055ea247cb0dc068f07f557 Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
* Docs: Fix cannot find networksettingsqml warningNicholas Bennett2021-12-151-2/+2
| | | | | | | | Updated the location to ../networksettingsqml . Pick-to: 6.2 6.3 Change-Id: I62273c488a2c03c4c4661af67851381571c5aa5c Reviewed-by: Pasi Petäjäjärvi <pasi.petajajarvi@qt.io>
* Refactor SettingsUI source code and add QML module supportPasi Petäjäjärvi2021-12-142-6/+1
| | | | | | | | | | | | | | Split application and plugins structure to use QML modules feature Move settingsui binary and plugins it uses under examples as those are not really documented nor production quality. Task-number: QTBUG-97737 Pick-to: 6.2 6.3 Change-Id: I4b030a5a42b29554a45c23eab4170be980cd5dc5 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
* Doc: Remove references to qmake support, it's already gonePasi Petäjäjärvi2021-10-271-8/+0
| | | | | | Pick-to: 6.2 Change-Id: I5ae83f4e68ae292926246e195855451e6e9ae8a4 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Port qtdeviceutilities to use declarative typesDan Ackers2021-06-241-1/+1
| | | | | | Task-number: QTBUG-94426 Change-Id: I9ac17f38eccff96e25a6c1d40998b222d349274d Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Remove all qmake filesSamuli Piippo2021-06-141-9/+0
| | | | | | | Support builds only with CMake. Change-Id: I4b242a27d2d747ffa2d9b55a43f0d2b8f5f4cbc2 Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Doc: Fix documentation build issuesTopi Reinio2021-05-054-27/+16
| | | | | | | | | | | | * Add dependency to Qt Core for the documentation build; QDoc requires Qt-specific include paths * Restore custom module header to pull in NetworkSettings include path * Restore doc.pro as it's referenced from src.pro Task-number: QTBUG-93174 Change-Id: Ie06858bd6737348a0a7711560be83eef60de3af6 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Enable documentation buildLassi Lehikoinen2021-03-043-17/+4
| | | | | | | | | Added a configuration flag to build the documentation. Qttools dependency is required for the QDoc for building the docs. Task-number: QTBUG-90829 Change-Id: I8dbff713184939db24f087129b3891e5a553adad Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Update documentation regarding Qt 6 changesLassi Lehikoinen2020-12-294-56/+22
| | | | | | Task-number: QTBUG-88332 Change-Id: Ie6b9310e73b5515c97c892fbc27cd89009011c98 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Build device utilities with CMake and qmake against Qt 6Lassi Lehikoinen2020-12-161-0/+2
| | | | | | | | Also fix compiler warnings. Task-number: QTBUG-88317 Change-Id: Iff6014613a7d12426b6fe692dff0000c92930ace Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Fix the list of linked Device Utilities modulesTarja Sundqvist2019-03-184-48/+61
| | | | | | | | | | | All Device Utilities modules are listed in the main page. Also All C++ classes / All QML Types pages added. Task-number: QTBUG-74231 Change-Id: Ia6b091e6d136b844c36de94f8fafa0bb7b199777 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Samuli Piippo <samuli.piippo@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Doc: Fix help contents in Qt CreatorLeena Miettinen2018-12-101-9/+9
| | | | | | | | | The QML Types and Examples links were missing in the Contents view in the Qt Creator Help mode. Change-Id: Ib0555364f19c2e859d5da9f80fa22b2d932c8d92 Reviewed-by: Mikko Gronoff <mikko.gronoff@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Doc: Fix typo in file nameTopi Reinio2018-10-241-0/+0
| | | | | | | qtdeviceutitilies-module-cpp.qdoc -> qtdeviceutilities-module-cpp.qdoc Change-Id: Ic9727ac2b532ac7d33b026655b2af98a5ff4d25c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Fix landing page titleTopi Reinio2018-10-241-1/+1
| | | | | | | | | | | | | | | Commit 261e4c6 exposed a problem with the landing page by modifying its HTML filename: Landing page has a different title than what's defined in qtdeviceutilities.qdocconf. Until 261e4c6, the TOC was built corrently because the default index filename (index.html) was correct. Fix the landing page title using the provided macro '\maintitle'. Task-number: QTBUG-71198 Change-Id: I37d219d24e8d0395517f75c230942b3733ce31aa Reviewed-by: Mikko Gronoff <mikko.gronoff@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Add documentation for C++ classesLeena Miettinen2018-10-1513-118/+294
| | | | | | | | | Currently, only QML types are documented. Task-number: QTBUG-69686 Change-Id: Idc13bff25a154e88c6c769c0af37204573ec1118 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Update license headersSami Nurmenniemi2017-11-243-18/+45
| | | | | | | | | | Documentation files now use qtbase/header.FDL and scripts qtbase/header.GPL licenses. Task-number: QTBUG-64693 Change-Id: I2c0f6fe8ece7434f9dc68c1a185532ae6eb023fa Reviewed-by: Samuli Piippo <samuli.piippo@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Add a wifi exampleVille Voutilainen2017-09-073-2/+103
| | | | | | | | | | | | | | The WiFi tutorial linked to NetworkSettings module and NetworkSettingsManager QML type. Added a section Tutorial and Example Code to a module reference page. It contains a link to WiFi tutorial and provides the Settings UI Git repository as an additional example code for Qt Device Utilities. Task-number: QTBUG-56694 Change-Id: Ib6c6a446fd36530525d521e5d568ec154d58a63d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Doc: Bump version to 5.9.1Topi Reinio2017-06-202-7/+8
| | | | | | | | | | | | | | | | Do this by making the main module version in .qmake.conf follow the corresponding Qt for Device Creation versioning. This allows $QT_VERSION et al. to be used in the doc configuration. Make the full version visible in documentation, to help distinguish between installed documentation sets with identical major/minor versions but different patch version. After this change, simply updating .qmake.conf is sufficient for subsequent version increments. Change-Id: Ib0a1ecb5a44d9f2530fa2df3b8daf7b3e541f884 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Doc: Bump version to 5.9.0Mikko Gronoff2017-05-031-2/+2
| | | | | | Change-Id: I3cb1d82db78155fcf5d53d198bb212bb52a90823 Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io> Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* Doc: Bump version to 5.8.0Mikko Gronoff2017-01-191-2/+2
| | | | | Change-Id: I7f29e0c11499833404d940a0d8faf11f4713aae9 Reviewed-by: Teemu Holappa <teemu.holappa@qt.io>
* Doc: Document QtDeviceUtilitiesTopi Reinio2016-09-062-17/+35
| | | | | | | | | | | | | | | | | | | 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>
* Doc: Remove rest of the generic Qt for Device Creation doc filesTopi Reinio2016-09-013-347/+0
| | | | | | | These are moved to tqtc-boot2qt/doc repository. Change-Id: I8772597b684f292cfffe583e4eaa01679e7ec80b Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Bump version to 5.7.1Topi Reinio2016-09-011-2/+2
| | | | | Change-Id: Ib32751d25e698844c4f6ced6fc107983a67923b5 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Merge remote-tracking branch 'origin/5.6' into 5.7Samuli Piippo2016-09-0137-3669/+99
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * origin/5.6: Doc: Remove generic Device Creation documentation Conflicts: src/doc/config/b2qt-project.qdocconf src/doc/src/devices/qtee-bd-sl-imx6.qdoc src/doc/src/devices/qtee-beaglebone-black.qdoc src/doc/src/devices/qtee-kontron-smarc-samx6i.qdoc src/doc/src/devices/qtee-raspberry-pi.qdoc src/doc/src/devices/qtee-sabre-sd-imx6.qdoc src/doc/src/devices/qtee-supported-devices.qdoc src/doc/src/devices/qtee-toradex-apalis.qdoc src/doc/src/devices/qtee-toradex-colibri-imx6.qdoc src/doc/src/devices/qtee-toradex-colibri-vf.qdoc src/doc/src/qtee-changelog.qdoc src/doc/src/qtee-custom-embedded-linux.qdoc src/doc/src/qtee-index.qdoc src/doc/src/qtee-static-linking.qdoc src/doc/src/shared/detect-sd-card-device-name.qdocinc Change-Id: I52b87c5c383c6419a35d06cb2a0c87073c9d3c85
| * Doc: Remove generic Device Creation documentationTopi Reinio2016-09-0139-3684/+129
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ... and replace the documentation configuration with a one specific to Boot to Qt Utils. The removed documentation is available in a dedicated repository, tqtc-boot2qt/doc. The name of this module in 5.6 branch will be 'Qt for Device Creation: Add-On Modules'. The doc namespace and config files already reflect the name 'Qt Device Utilities', but that is not visible to the user in 5.6 (but will be in 5.7). Change-Id: Ib5a98d57b6ff5e7c29901f42697266f396abad82 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* | Added additional instructions for Windows users using BeagleBone BlackKari Hormi2016-06-301-0/+12
| | | | | | | | | | | | | | | | - Added additional instructions for those who don't see their BBB board in ADB when running Windows. Change-Id: I95505a5ab98af8b281299450a554a191aea2357c Task-number: QTBUG-54409 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Doc: Add documentation for NVIDIA DRIVE CXTopi Reinio2016-06-106-1/+92
| | | | | | | | | | Change-Id: Ib8d3f9ed1abd289e46c6e05102fccf5e91ad0513 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Doc: Add documentation for Intel NUCTopi Reinio2016-06-105-0/+118
| | | | | | | | | | | | | | Task-number: QTBUG-53889 Change-Id: I2698ea1e9ee1e95a8ec863cdf8c5e3737ccb8e81 Reviewed-by: Gatis Paeglis <gatis.paeglis@qt.io> Reviewed-by: Teemu Holappa <teemu.holappa@theqtcompany.com>
* | Doc: Remove references to SILICA ArchiTech TibidaboTopi Reinio2016-06-095-88/+5
| | | | | | | | | | | | | | | | ... and document its removal in the changelog. Task-number: QTBUG-53889 Change-Id: I173ec32f51f66b4c002d8ec99ec7b87f7a024abe Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* | Doc: Bump version to 5.7.0Topi Reinio2016-06-0913-23/+28
| | | | | | | | | | | | | | | | ...And document the switch to Yocto 2.0 release. Task-number: QTBUG-53889 Change-Id: I2bf3c9b21f050e38b77723f5243a6958199e55e3 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* | Add support for Raspberry Pi 3Tuomas Heimonen2016-05-255-13/+31
| | | | | | | | | | | | | | Move Raspberry Pi 2 to unsupported Change-Id: I7098e3ce8c94a0e08a54b5dd75893fa700a96638 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | doc: Add emulator build instructionsLeena Miettinen2016-05-234-2/+210
| | | | | | | | | | | | | | Task-number: QTAUTO-141 Task-number: QTAUTO-142 Change-Id: I14fb793f937702dfcb564555334c8ce5726a4f24 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* | Doc: Update static build documentationTopi Reinio2016-05-031-17/+8
| | | | | | | | | | | | | | | | | | | | | | - Update the instructions to use correct mkspec and sysroot paths - Copying the mkspec step no longer needed - Mention Qt WebEngine not supporting static builds. Task-number: QTBUG-53117 Change-Id: I79b506b154f3fe36e02fbffee073bd0ad1b48cc1 Reviewed-by: Samuli Piippo <samuli.piippo@qt.io>
* | doc: Add headline before next sectionRainer Keller2016-04-211-0/+2
|/ | | | | | | | Otherwise it will look like the USB setup section is related to the multi- touch adapter section. Change-Id: Ic59ca4b2e961a4b101a552f4fdf5dd792da3463e Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: ChangeLog for 5.6.0Topi Reinio2016-03-111-1/+35
| | | | | Change-Id: Iafd914307c1fe5150327e82f5194f590593b177a Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
* Doc: Fix small inconsistency for tree element separator.David Schulz2016-03-111-1/+1
| | | | | Change-Id: I1f1961d03286707654af614d64ead48a8c0b542f Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
* Doc: Update which Yocto release is used.Topi Reinio2016-03-101-1/+1
| | | | | Change-Id: Ice8b1dcce328316d373273a538b991f04233bced Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
* Doc: Clarify GPU options in i.MX6 boardsTopi Reinio2016-03-101-1/+1
| | | | | | | | i.MX6Solo has a different GPU compared to other variants. Task-number: QTEE-934 Change-Id: Ib204b7dd0a312449a64eda8451674e2879cd2a05 Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
* Doc: Also support Windows as a development host system.David Schulz2016-03-108-26/+84
| | | | | | Change-Id: Ia8639f5548d6795020f4f3a7dfefabab03760071 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com> Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com>
* Doc: Remove duplicated file.David Schulz2016-03-041-45/+0
| | | | | | | The original is located under src/doc/src/shared/. Change-Id: If6211bd668108bf82b97afeae47b9f279b26513c Reviewed-by: Teemu Holappa <teemu.holappa@theqtcompany.com>
* Doc: Add note about resetting U-Boot env.Gatis Paeglis2016-02-261-0/+9
| | | | | | | | | This is to be consistent with documentation for other devices. Change-Id: I58f1dc8ca936941f0da8a5c4a4a0275a740d8379 Reviewed-by: Samuli Piippo <samuli.piippo@theqtcompany.com> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* doc: update toradex u-boot commandsSamuli Piippo2016-02-252-3/+12
| | | | | | Task-number: QTEE-978 Change-Id: I44be872855f8449d5cef7b0f48b579ae753ac30f Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* doc: update kontron board instructionsSamuli Piippo2016-02-241-1/+1
| | | | | | | New version of the BSP has memory card in different device. Change-Id: I16316d49a547354f8ddcba91d6bd6c75d488d13f Reviewed-by: Teemu Holappa <teemu.holappa@theqtcompany.com>
* doc: update yocto documentationSamuli Piippo2016-02-151-43/+21
| | | | | Change-Id: Ibc03a5b61c6b08ca898dd09bc98ce75ea2844bd7 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: List the 3rdparty components used by the Qt add-onsVenugopal Shivashankar2016-02-102-2/+43
| | | | | | | | The Qt Virtual Keyboard and Qt Quick 2D Renderer use several 3rdparty components. Change-Id: I2f60ac5bed2469b48046ccda10d3e44c357923c4 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* doc: imx6 u-boot update instructionsSamuli Piippo2016-01-181-23/+15
| | | | | | | | How to update u-boot for all boundary devices. Remove display settings, no longer needed in the new image. Change-Id: Icf34e084174f03024bd240eca4d717442be9bd7a Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>