Commit Graph

33 Commits

Author SHA1 Message Date
Leena Miettinen
5633533e0d Doc: Update Android docs
Fixes: QTCREATORBUG-28858
Task-number: QTCREATORBUG-28721
Change-Id: Id18a2ad0f88600362a5d10e36b3e3d95e5d19644
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2023-03-21 10:35:39 +00:00
Leena Miettinen
738819ec71 Doc: Replace "provide" with something simpler
This follows the ComplexWords rule in vale.

Change-Id: I99d8e5dc3ee4736a254064b6ef00166419fccee8
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2023-02-06 11:09:29 +00:00
Leena Miettinen
ce0f48e0f9 Doc: Replace "contain" with "have" to simplify language
This follows the ComplexWords rule in vale.

Change-Id: Ie5dbb7ac1eff1546dcfbe2bf5da6cc3ed18b7a20
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
2023-02-03 15:06:17 +00:00
Leena Miettinen
be1aa6abed Doc: Fix typos
Change-Id: I22b610a6dcab73867f915f877d7b7b844da5dc22
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2022-11-16 10:39:24 +00:00
Leena Miettinen
65cfbc1b6e Doc: Use "remote Linux" instead of "generic remote Linux"
- Reflect the term changes in the UI.
- Move info about SSH port property to the wizard step list.
- Make the topic names in "Deploying to Devices" shorter.
- Remove some unnecessary "if defined(qtdesignstudio)" conditions
  from topics that are not used in the QDS Manual.

Task-number: QTCREATORBUG-27876
Change-Id: I2282257f245c31af82a41ea0e533407bf1cbd775
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2022-11-08 08:31:30 +00:00
Leena Miettinen
18553f051c Doc: Remove \if defined statements from files not used in QDS
Change-Id: Ib6c3bf5a89faab97fd28b47e033925c2f4f30f55
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-10-31 07:38:50 +00:00
Lucie Gérard
a7956df3ca Use SPDX license identifiers
Replace the current license disclaimer in files by
a SPDX-License-Identifier.

Task-number: QTBUG-67283
Change-Id: I708fd1f9f2b73d60f57cc3568646929117825813
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-08-26 12:27:18 +00:00
Leena Miettinen
9074fa27e0 Doc: Describe "Create Android Template Files Wizard"
Task-number: QTCREATORBUG-27560
Change-Id: I9f7a24b2d0c9ddfd3282fda59c4262d0b6775f56
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-07-12 11:10:04 +00:00
Leena Miettinen
226abd4de7 Doc: Do not use comma before "because"
Change-Id: I375342fa10b95e26a3de2524610905c4d5503d3e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 10:39:52 +00:00
Leena Miettinen
89be4d7d17 Doc: Replace "options" with "preferences"
...when referring to Preferences dialog.

Task-number: QTCREATORBUG-27560
Change-Id: I2f41420b0ec5955d84ad715d239209adddff0529
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-07-12 07:30:49 +00:00
Leena Miettinen
f0c9849e3a Doc: Update info about Android Device preferences
Task-number: QTCREATORBUG-27560
Change-Id: Ice201b62930cc04906d17fa647c555abec77c597
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-07-04 11:37:16 +00:00
Leena Miettinen
2364761c8e Doc: Document new Python language server options
Task-number: QTCREATORBUG-27560
Change-Id: I659f9ef11b25363126ca387c2844bdddfa33f284
Reviewed-by: David Schulz <david.schulz@qt.io>
2022-07-01 10:21:28 +00:00
Leena Miettinen
b5066d71b8 Doc: Replace "Tools > Options" with "Edit > Preferences"
The menu was moved and renamed. The Options dialog was
also renamed "Preferences".

Change-Id: I05d187915382b3ce49699d91304cd447c87e2bd6
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-06-28 08:32:44 +00:00
Leena Miettinen
09804a65e4 Doc: Do not use the term "Output pane" in docs
When necessary, replace it with "view". When possible,
rephrase to omit the term. Link to descriptions of the
output views.

Update screenshots.

Change-Id: I80ccd12f5a10f221bbea6de994a15ddd07d20842
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2022-03-09 15:30:36 +00:00
Leena Miettinen
fc82e593af Doc: Update Qbs settings
Task-number: QTCREATORBUG-26610
Change-Id: I98261c9fa36f34d8b13a2b12a3a545f6662916b5
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2022-02-28 16:56:58 +00:00
Leena Miettinen
659d82c499 Doc: Fix broken links when building with Qt 6
Some section titles have changed in Qt 6 and some
platforms and modules are not supported. Where necessary,
use fixed links to Qt 5 docs.

Fixes: QTCREATORBUG-27015
Change-Id: I469a630731f9c37deffe5ca454f5365310aaf713
Reviewed-by: Tommi Mänttäri <tommi.manttari@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2022-02-28 16:05:01 +00:00
Leena Miettinen
3926e708a9 Doc: Update info on Android settings
Fixes: QTCREATORBUG-26672
Change-Id: Ifaf9f28b485f965302bca9aa2ec2a308b96d4b34
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2022-02-08 12:39:57 +00:00
Leena Miettinen
eae031df4a Doc: Copy icons from sources to \doc\qtcreator\images\icons
- Fix the paths to them in .qdoc files
- Remove paths to source folders from .qdocconf files

This is the second step towards making the icons visible in both
dark and light online doc modes.

Task-number: QTCREATORBUG-26644
Change-Id: I6995ea716df78cf0f285175515d1466ee20e317b
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 10:44:55 +00:00
Leena Miettinen
068e89eb63 Doc: Use a fixed link to refer to a Qt 6 command
The docs are built with Qt 5 for production, so a fixed
link is needed to:
QNativeInterface::QAndroidApplication::hideSplashScreen()

Task-number: QTCREATORBUG-26278
Change-Id: I9228ea53381532a1b4a5bea863802ea4e97f2956
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2021-11-25 09:07:29 +00:00
Leena Miettinen
8f98f61ed4 Doc: Update info on developing for Android devices
Task-number: QTCREATORBUG-26312
Change-Id: Ic95a7c6ea4b0ab092a1b1feb07bba3dd368a3584
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2021-11-02 10:41:58 +00:00
Leena Miettinen
2dfe37f1cf Doc: Remove description of obsolete Run field in Android Manifest
Task-number: QTCREATORBUG-25642
Change-Id: If70772a79f0aae5990ca962112e00da7b9c7f3ec
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
2021-08-09 08:06:55 +00:00
Leena Miettinen
1325be78d9 Doc: Describe Boot2Qt Plugin
- Add connecting to Boot2Qt devices topic
- Move information about deploying to the generic
  embedded Linux devices topic to a Boot2Qt topic

Fixes: QTCREATORBUG-25946
Change-Id: I72f12ceece133f4a4efe303e82d25a3b5e9b9135
Reviewed-by: Rami Potinkara <rami.potinkara@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-07-09 14:36:17 +00:00
Leena Miettinen
9d0c3dc3d6 Doc: Describe new Language Client options
Fixes: QTCREATORBUG-25530
Change-Id: Ia59e476cdd6a1d655f269293c8e6ef97c5b084b5
Reviewed-by: David Schulz <david.schulz@qt.io>
2021-03-26 07:53:07 +00:00
Leena Miettinen
3c7ab41e9e Doc: Update info about Android Manifest Editor
Describe package names, styling, screen orientation, and
screen resolution options in more detail.

Update and add screenshots.

Fixes: QTCREATORBUG-24863
Change-Id: Ie365f6c7c634e2035a50666fe35785df56e44596
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-11-03 09:18:00 +00:00
Leena Miettinen
a85e5ce618 Doc: Update information about developing for Android devices
- Users can now add images to use as splash screens.
- Restructure the information to promote the automatic setup.
- Remove obsolete and duplicate information.
- Move external links to external-resources file.

Change-Id: I9578ff8615bb2a0db528f45276d16a838554b143
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-08-11 08:16:43 +00:00
Assam Boudjelthia
def7615c81 Android: fix a title capitalization
Change-Id: I5b22d95b85543f110f7c292d06112c1b72c337bf
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2020-07-22 14:35:11 +00:00
Assam Boudjelthia
c90d1c61ce Android: recommend AdoptOpenJDK in settings UI and docs
Show JDK downlaod button on Linux and point it to OpenJDK becuse
it's the most used on Linux. Otherwise, recommend AdoptOpenJDK because
it works on all platforms and easy to install as well.

Change-Id: I94fd61262fe759b96db59a9e2abfbd063f6795f0
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-26 20:06:32 +00:00
Tarja Sundqvist
a68e6a4fb1 Add Android services to the manifest editor documentation
Task-number: QTCREATORBUG-24075
Change-Id: Ifd3ec1ee52fede81eec4c18a3c5c5a23eb44132b
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-06-08 13:44:20 +00:00
Leena Miettinen
c370d345f1 Doc: Remove obsolete \contentspage command
This prints a QDoc warning when building with QDoc 5.15.

Change-Id: Id6f4646738f3e09956a243dc0da639f5567470f3
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-05-11 08:43:31 +00:00
Leena Miettinen
faa8547b12 Doc: Fix links to QtAndroid functions
Add a dependency to the Qt Android Extras module to the
doc configuration file to enable linking to the module.

Change-Id: I69271554f78a0d73fc44032f9310e9670b06961e
Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
2020-04-20 11:56:50 +00:00
Leena Miettinen
0f1d0082aa Doc: Fix path to project wizards
Update screenshot

Task-number: QTCREATORBUG-23364
Change-Id: I3b1c56eed1603fac60f884f4685ce3da8263a4b3
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2020-04-06 06:41:34 +00:00
Assam Boudjelthia
96e5eca1c3 Docs: update Android docs to reflect the latest changes
Docs affected:
* Connecting Android Devices
* Deploying Applications to Android Devices
* Specifying Run Settings for Android Devices

Task-number: QTBUG-80390
Change-Id: I17fecd4d947644d8cc6071af68addbc2199ad82e
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-03-30 18:57:41 +00:00
Leena Miettinen
5fc456dd22 Doc: Rearrange files in the doc folder
Source and configuration files for each manual are now located in a
separate subdirectory, with common configuration files in doc/config.

doc
|_config
|_qtcreator
|_qtcreatordev
|_qtdesignstudio

Edit the config files accordingly.

Change-Id: Idc747a7c16e84f3e06add91234dc5fc908e64cc5
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-01-27 09:05:07 +00:00