Commit Graph

18 Commits

Author SHA1 Message Date
Leena Miettinen
81898c675c Doc: Add a \preferences macro and use it everywhere
The macro can be used to show the path to Preferences
on Windows, Linux, and macOS. The current value expands to:
"Edit (or Qt Creator on macOS) > Preferences".
We can now change this in one place if we so wish.

Task-number: QTCREATORBUG-29734
Change-Id: I9afe4f7093dbcc8e62a2b18e1ae3f6f243bbb72b
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-10-18 14:43:29 +00:00
Leena Miettinen
ff856ed030 Doc: Describe changes in enabling mixed C++/QML debugging
The check boxes are now combo boxes with several options.

Task-number: QTCREATORBUG-28996
Change-Id: Ib3ba3abb5c307b4fecffd267084bb2bd4057add9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-06-21 07:03:10 +00:00
Leena Miettinen
670d36a931 Doc: Don't mention qmake in Qt Quick debugging instructions
The same field is available for both qmake and CMake projects.
Use a screenshot from a CMake project.

Also point to "Preferences > Build & Run > Default Build Properties"
for globally enabling QML debugging and explain what "Use Project Default"
and "Leave at Default" mean.

Fixes: QTCREATORBUG-29089
Change-Id: I3d007d10ca3247dc387eaf21d4d4623d7e90167d
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2023-05-11 07:31:32 +00:00
Leena Miettinen
1e6933f48d Doc: Reorganize the Debugger topic
Divide the long topics into shorter ones and reorganize the
information.

The next step will be to improve the current topics: check that
the information is complete, add screenshots for all views, add
links between related topics, and so on.

Task-number: QTCREATORBUG-28778
Change-Id: I3549289a2be512bb09f45c91f85b12f89cedbe97
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: hjk <hjk@qt.io>
2023-02-13 14:37:39 +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
bddac59a95 Doc: Fix arguments to start debugging Qt Quick applications
A dash was missing.

Fixes: QTCREATORBUG-28093
Change-Id: Ic7fbf8fda8d23fdc1eabf98b53240824a24aacc5
Reviewed-by: hjk <hjk@qt.io>
2022-08-23 07:14:22 +00:00
Marcus Tillmanns
1e70973c32 qml-debug-doc: Inform the user that breakpoints are only available in block mode
Setting / triggering breakpoints is only possible
if the target application was started with the
"block" argument.

Fixes: QTCREATORBUG-27515
Change-Id: Idafdaa87c38c8c452771897d4d845c4398d55fc4
Reviewed-by: hjk <hjk@qt.io>
2022-06-17 08:37:58 +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
Mats Honkamaa
741a2de6b9 Doc: Document toggling visibility of menu items
Debug, Analyze, and Build menu items are invisible by default.
Visibility can be toggled from Options.

Task-number: QDS-6372
Change-Id: I5134868e8cd08c229b6c3a8ff3c53a1cc67949ab
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2022-02-28 15:08:45 +00:00
Leena Miettinen
229d26df6f Doc: Describe CMake config for debugging running Qt Quick apps
The target_compile_definitions(myapp PRIVATE QT_QML_DEBUG) command
is used.

Task-number: QTCREATORBUG-26616
Change-Id: Ifde5f6f11081afa8af19e0339733d7380d1d14be
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2021-12-14 08:04:37 +00:00
Leena Miettinen
73fa76f776 Doc: Remove info about Qt Quick Designer plugin from Qt Creator Manual
Fixes: QTCREATORBUG-26321
Change-Id: I8738cbdc56d6469a4d133b17741871787e0cba9f
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-10-18 07:21:39 +00:00
Leena Miettinen
d241832e07 Doc: update info about qmake build configuration
Change-Id: I40e7491b079ae879d97b595fb2d440b92a11d66b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2021-03-31 10:25:45 +00:00
Leena Miettinen
a8cfe3d560 Doc: Fix menu paths to submenus and items that moved to View menu
The Views and Workspaces menus as well as some menu items were moved
from Windows to View.

Change-Id: I2e196c09f0e9e2bf8ef1623167ec3e87ed1f77f5
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-06-30 10:35:07 +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
Eike Ziller
708f84cce8 Doc: Fix style for menu hierarchies
Use \uicontrol for the individual components individually

Change-Id: Idf62db7c37e94a55a988792f13aaa8c49cb1ac07
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2020-04-03 06:10:16 +00:00
Leena Miettinen
74f04c17d1 Doc: Update info about build settings
QML debugging and profiling, separate debug info, and
Qt Quick Compiler are now enabled in the general build
settings. Default values can be set in Build & Run options.

Task-number: QTCREATORBUG-23686
Change-Id: I6eef8f270ab42cc563c3c95cfddf22243a5ef017
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2020-03-05 13:43:24 +00:00
Leena Miettinen
5997f9754d Doc: Add a note that qmltooling plugins are required for QML debugging
Task-number: QTBUG-82039
Change-Id: I042b8212e3571b806e9a35b12fa83cc84006b2e6
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2020-02-11 14:42:17 +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