Commit Graph

4240 Commits

Author SHA1 Message Date
Leena Miettinen
aa588449b0 Doc: Move more files
To enable single-sourcing Qt Creator Manual and Qt Design Studio
Manual.

Change-Id: I88bf1f094a7ec31cce3ac2924987296f71e9cb74
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-09-07 08:59:31 +00:00
Leena Miettinen
07ea3b2687 Doc: Use defines in the "Keyboard Shortcuts" topic
...to enable single-sourcing Qt Creator Manual and Qt Design
Studio Manual. Update the screenshot.

Change-Id: Ia00e93c8a946564d41706e6ccbb8c0ec18647acf
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-09-07 08:58:51 +00:00
Leena Miettinen
29db0af9f8 Doc: Restructure refactoring information
Separate C++-specific info from QML-specific info.
Use defines to support single-sourcing. Add screenshots
that show QML code.

Change-Id: I35f01673de555074cc23e96b36200d15d6b34fce
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-09-07 08:44:11 +00:00
Leena Miettinen
7125f6853d Doc: Use defines in "Indenting Text or Code" topic
To enable single-sourcing Qt Creator Manual and Qt Design Studio
Manual.

Add the menu path to Typing options.

Change-Id: I99708fe39d414462c743b0f01a52dcefcce1d65b
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-08-31 08:15:25 +00:00
Eike Ziller
8e05783019 Merge remote-tracking branch 'origin/4.7'
Change-Id: I4332eba9f1f66fef185359c79c4d96420d8b78ca
2018-08-30 08:31:25 +02:00
Christian Stenger
7ba5bddded Doc: Correct license header
Change-Id: I5324b4a8ee23a7203591e0c35875027d8ac93e0d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2018-08-29 12:11:06 +00:00
Leena Miettinen
e1e1790402 Doc: Update locator information
- Use QML code in examples and enable the hiding of
  C++-specific information by using defines.
- Update screenshots
- Update info about "Filter Configuration" dialog

Change-Id: Ia2ca4220a46308c6f480965153ac1002f9790054
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-08-28 10:26:25 +00:00
Leena Miettinen
21b2c1d04a Doc: Update information about checking QML and JavaScript code
The error messages and codes are displayed when you write code.
The JSON information is unrelated and was moved further down the
topic.

Added a screenshot of checking QML code.

Used defines to mark C++ specific parts.

Change-Id: I08a122727200208474036adec56afd6235b56d6a
Reviewed-by: Marco Benelli <marco.benelli@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-28 09:40:47 +00:00
Leena Miettinen
f06f9122d7 Doc: Add screenshots for QML code completion
Use defines to hide C++-specific info from Qt Design Studio
Manual.

Change-Id: Ia1a0f730f8999e5b6f1dfe69779729bb90c46a1d
Reviewed-by: Marco Benelli <marco.benelli@qt.io>
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-08-28 07:31:17 +00:00
Leena Miettinen
3b2a7c0b52 Doc: Reflect changes in Qt Design Studio Manual structure
Change-Id: I811c8715e02e8013c7e34c6dbf0b7a1e60205383
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-27 09:47:50 +00:00
Leena Miettinen
97c56225a7 Doc: Move topics in creator-editors.qdoc to individual files
To enable single-sourcing of the Qt Creator Manual and Qt Design
Studio Manual. No content changes were made in this patch.

Change-Id: I2bc1db22310bcef539d5961e728a565142c2e2d4
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-08-23 11:24:44 +00:00
Leena Miettinen
2dba79df26 Doc: Use defines to show and hide info about Edit mode
Move the descriptions of sidebar views to
creator-sidebar-views.qdocinc to be able to include them
in the "Working in Edit Mode" topic in the Qt Design Studio
Manual.

Restructure the section and update the screenshot. A different
screenshot for the Qt Design Studio Manual will be added in
its doc sources.

Change-Id: Icd33c580c040ffefa5563fea723bd02e2d2ce520
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-23 10:53:19 +00:00
Leena Miettinen
9550f3ac95 Doc: Use defines in "Creating Components" to view and hide info
For single-sourcing Qt Creator Manual and Qt Design Studio Manual.

Change-Id: Ic771280121d56d11bcc8eccd7edbf0b4bc72eefb
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-23 10:52:51 +00:00
Leena Miettinen
148d64dc89 Doc: Reorganize Qt Quick debugging information
QML-specific information about evaluating expressions at
runtime was already there, so linking to it instead of the
C++-specific info. Moved all information about the Debugger
Console to this topic, after the information related to the
Locals and Expressions views.

Hiding C++ and Qt version specific information.

Change-Id: Icf8798521218fca4ee6dea65b2e96ce685027a37
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-08-21 12:53:35 +00:00
Leena Miettinen
7ab07a4e8f Doc: Move files to enable single-sourcing
Create creator-only folders for topics that are to be excluded
from the Qt Design Studio Manual.

Change-Id: I6e212c6f1f2911fd02b135fe72e6379ef95c9eee
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-08-20 09:44:20 +00:00
Leena Miettinen
ee9745e3da Doc: Update info about Git
- Move all information about Git to the Git-specific topic
- Add missing information

Change-Id: I54bc19fd05ac100e8fbb03b3103754e8eb04fa01
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
Reviewed-by: André Hartmann <aha_1980@gmx.de>
2018-08-20 09:36:51 +00:00
Leena Miettinen
6564922254 Doc: Move common debugger functions to an include file
Some debugger functions are used for both C++ and QML debugging.
Putting them into an include file enables using the descriptions
in both the Qt Creator Manual and Qt Design Studio Manual.

Change-Id: Ief7e1e1c76a881eb6722161a1b216b3d711c6290
Reviewed-by: hjk <hjk@qt.io>
2018-08-17 12:37:44 +00:00
Leena Miettinen
a90dd96621 Doc: Move qtquick-profiler.qdoc to the "qtquick" folder
It is needed for the Qt Design Studio Manual, where the
"analyze" folder is now excluded from doc sources.

Change-Id: Ic5fc97f05ca84e428be6309979e2927563c9e814
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-08-16 14:49:18 +00:00
Leena Miettinen
8828d79c4a Doc: Use defines in navigation links
To be able to build Qt Creator Manual and Qt Design Studio Manual
from the same sources.

Change-Id: I6adbc7b7f23c40f24508a8de7ae9ad5a2a3a103e
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-16 14:48:46 +00:00
Eike Ziller
eb0f3997ad Update macOS requirement for binary packages
Qt 5.11 does not support macOS 10.10

Change-Id: I7438b1354c006447d7ba2148ebe616dafe39ef53
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-08-16 08:32:46 +00:00
Leena Miettinen
c76db4d085 Doc: Use defines to enable hiding device-related information
Currently, only Android and embedded Linux devices are supported
by Qt Design Studio.

Change-Id: I10005f6a9cfeb93c99447796c1c9e6d47ab578de
Reviewed-by: Vikas Pachdha <vikas.pachdha@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-08-16 07:34:50 +00:00
Leena Miettinen
d8c81edfad Doc: Remove a note that is no longer applicable
Compiling the library should not be necessary since the QML
debugging library has been added to Qt.

Change-Id: Id1d31cb40068fcfb7ff868ae80e3f3c9bc4b5de7
Reviewed-by: hjk <hjk@qt.io>
2018-08-10 12:51:56 +00:00
Leena Miettinen
2b877246ca Doc: Add a note about debugger error on Android
Qt Creator cannot debug applications on Android devices
if Android Studio is running.

Change-Id: I57de367ed0d4effe7b095fa66318408d868496d1
Reviewed-by: hjk <hjk@qt.io>
2018-08-10 09:33:30 +00:00
Andre Hartmann
8e8598f2a3 Coding Style: Update null pointer description to C++11
Task-number: QTCREATORBUG-20852
Change-Id: I150b8e815e137fee333b71d3b05c3a4d2a0038ba
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-07-26 10:11:03 +00:00
Leena Miettinen
ac674bac03 Doc: Describe newly supported Qt Quick Controls 2
Support for several controls has been added to the Library in the
Design mode.

Change-Id: I9822f7379991eea3b32f47574e3c3548445d538d
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-19 14:00:48 +00:00
Artur Shepilko
06d73b2e24 Update copyright year
Change-Id: I2b1db2013cad9d25d2a54439866aae63a62623f0
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2018-07-16 20:49:28 +00:00
Leena Miettinen
8daca461c2 Doc: Add 3rd-party libraries to Acknowledgements
Reformat parts of the existing text.

Task-number: QTCREATORBUG-20682
Change-Id: I019146d3861fe57258ba0ddc84ed3ed576128da9
Reviewed-by: Xing Xiong
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-07-13 12:35:45 +00:00
Leena Miettinen
41493d24f0 Doc: Replace title with HTML filename as value of \contentspage
To make links work if the title changes.

Change-Id: Icf516e74c68efc3b26689aaec27f28ee7ae51ce3
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-12 08:27:01 +00:00
Leena Miettinen
f18d2ded9b Doc: Move information about Qt Quick Controls to "Creating Components"
Move the topic up in the hierarchy. Will remove "Creating Screens" in
a follow-up commit.

Change-Id: I0de2bdc4706ab0cce13f5772006126b291e76b97
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-11 12:24:44 +00:00
Leena Miettinen
33998917c6 Doc: Move information about states to "Adding States"
Now that the states have their own topic, all information
about using states should be found there.

Change-Id: Iab1d17aeca9774e3e4bd3e50c776862aa4697a47
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-11 11:04:09 +00:00
Leena Miettinen
b5686f7f1b Doc: Describe Navigator and Properties in separate topics
To modularize the Qt Quick Designer docs.

Change-Id: Ia0ef0dbd07344375a7f145af16fe949e7807d55f
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-11 11:03:55 +00:00
Leena Miettinen
2cf84b8411 Doc: Pull information about C++ sidebar views into separate file
To make docs more modular.

Change-Id: I58095b2b4e9e216808cc4d37b3494480cbf1787c
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-07-06 08:19:26 +00:00
Eike Ziller
2e1f0c2578 Fix documentation build when renaming IDE
Do not rename documentation qhp file. The documentation qmake files
currently depend on the files having the same base name as the qdocconf file.
Also do not change the documentation namespace. There are places where
these are mentioned in translated strings.

Fixup of 54208113ee

Change-Id: Iace171535ea5be6e22fec9760a5d96722b052341
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2018-07-04 07:42:14 +00:00
Leena Miettinen
7201b26a52 Doc: Pull out "Adding States" into a separate topic
To further modularize the Manual.

Change-Id: I9b51ce951b92ff6690780de3d9f08f436169150d
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-07-03 12:54:25 +00:00
Leena Miettinen
69108b614a Doc: Add information about connections
Divide the subtopics into individual topics.

Change-Id: If32ada04e9f305cf9a2e3a03072026eac92d005a
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2018-07-03 10:01:47 +00:00
Christian Stenger
1207fd3a94 Doc: Fix link target
Name of target file has changed.

Change-Id: I5e80fdeab00d09671bf7be20a647117c894f8165
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-07-02 05:38:36 +00:00
Leena Miettinen
682b3079d2 Doc: Add a link to Acknowledgements to the front page
Change-Id: I405ceb8a4490c94c5ad695f06fb902c0a3f154a2
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-06-28 07:06:13 +00:00
Leena Miettinen
7d076e9e26 Doc: Add a link to contributor list to the Acknowledgements page
Task-number: QTCREATORBUG-20683
Change-Id: I9d2debac7badda999e129ca1b5d3d04923642f91
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
2018-06-27 12:11:30 +00:00
Leena Miettinen
e2e55a2f88 Doc: Replace "Qt Quick Designer" with "Design mode" or \QMLD
To make source text usable also for Qt Design Studio manual.

Change-Id: I7a5090ea2308a3091c34193cce3a8b57da1eb498
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-25 15:48:15 +00:00
Leena Miettinen
ef40f8445e Doc: Make info about managing projects more generic
The details are described in the listed topics.

Change-Id: I243eb8dc102ef42030a1a2e1b28af2679e6ca631
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-06-25 13:50:00 +00:00
Leena Miettinen
a8cbc1c4da Doc: Reflect changes in the names of Clang checks
Update the text and screenshot accordingly.

Change-Id: I0f89d7fc02ab6195cdf9d3e64188f0097688e98b
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
2018-06-21 12:44:13 +00:00
Christian Stenger
003f2ca5c7 Docs: Fix link target
Change-Id: I6e5f1d6b39682d708bab6c66ff9fd558996e5f1b
Reviewed-by: David Schulz <david.schulz@qt.io>
2018-06-21 10:43:45 +00:00
Leena Miettinen
2e6177fe86 Doc: Update Performance Analyzer docs
The tool was formerly known as "CPU Usage Analyzer", but can
now be used also for analyzing memory usage on devices.

Change-Id: I8e0c2b76be44340e5511c2cbb85efadb5a2f559d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-21 09:10:40 +00:00
Leena Miettinen
34e803c542 Doc: Fix typo "The the"
Change-Id: Id7dd22d7d3582a453a7ff18a431c31169fba4c69
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-20 12:27:01 +00:00
Eike Ziller
54208113ee Pass IDE_DISPLAY_NAME et al to qdoc and use it for manual
Change-Id: I5d52c9561d4c49df503c0e99c8765979516e5b5c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-20 10:01:52 +00:00
Leena Miettinen
a0083d06fd Doc: Remove product name from headings
The context of the whole manual is Qt Creator.

Change-Id: Ie63911c136ff98dfa6b0157d17a054a91a35fb11
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-06-19 12:53:01 +00:00
Leena Miettinen
3e017dc409 Doc: Use the \QC macro also for UI controls
Seems to work within the \uicontrol command.

Change-Id: I73769609091f88be9495410c50bce5296c1144f3
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-06-19 12:37:17 +00:00
Leena Miettinen
a876bde97f Doc: Edit information about using Clang tools
- Add descriptions of "Build the project before analysis" and
  "Simultaneous processes" options.
- Restructure the topic.

Change-Id: I7fdeecad3383d1fc76dccce7dd53df8bf0cd9d64
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
2018-06-19 10:37:10 +00:00
Ivan Donchevskii
75cda95039 Clang: Add option 'Build before analysis' to project settings
Diagnostic configuration Id was already there but
not the checkbox whether to build project or not.

Change-Id: Icb5fc15bda5eed5e375cd90df1a96060b30bf57e
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
2018-06-15 12:14:44 +00:00
Leena Miettinen
35cc6789d2 Doc: Describe running and debugging tests from code editor
Change-Id: Ieb19c1ca62a7fa785c5ba6b90c4aebe40b124dee
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2018-06-08 08:56:48 +00:00