Commit Graph

2663 Commits

Author SHA1 Message Date
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
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
Leena Miettinen
11e92fe789 Doc: Describe grouping Google tests by using GTest filters
Change-Id: I5f128de80ee8dc6ed0a2b42fd53834d041639113
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2018-06-08 08:31:37 +00:00
Leena Miettinen
3b8f0842a0 Doc: Update information about compiling Qt Quick Applications
This is an open source feature since Qt 5.11.

Change-Id: I9f1554dc880c0f69c6488e3281f6ae9e7f533c65
Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
2018-06-08 07:10:09 +00:00
Leena Miettinen
59b3737065 Doc: Edit information about Clang Code Model and Tools
Change-Id: I8482e34ce056dd9b6a5a20a0a7a2c7603ea9a4b0
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
2018-06-07 10:52:53 +00:00
Leena Miettinen
b816992a39 Doc: Describe "Add linker library search paths to run environment"
A general option for disabling library linking generally for all
projects.

Task-number: QTCREATORBUG-20240
Change-Id: I9f7f53e6deae7079613be32dadcd1325e5579720
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
2018-06-06 15:30:09 +00:00
Leena Miettinen
d3204ed5d4 Doc: Describe project type specific warning and error icons
... in the Projects view in the sidebar. Also, there is a big
Manage Kits button in the view now.

Change-Id: I3440fa34b98dba4c71a1c6a6559af31f7d9fd78c
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-06-06 12:23:51 +00:00
Leena Miettinen
e824ef5e0f Doc: Describe zooming into QML Profiler flame graphs
Change-Id: I3662a6998c7defaf05cefaadd62c3d69f0d73083
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2018-06-06 08:28:32 +00:00
Ulf Hermann
8798990fb1 Doc: Add troubleshooting entry for globally disabled perf events
Change-Id: Ia37b26cc83566b1ae802471c17ef8d309a5d2fa1
Task-number: QTCREATORBUG-20154
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-06-05 11:41:53 +00:00
Leena Miettinen
71f02417e7 Doc: Describe new file synchronization options
... in the Projects and File System views in the sidebar.

Change-Id: I38c77d8e5c19a1adb934c5b8d4777889467392c6
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-06-05 10:35:54 +00:00
Leena Miettinen
fff6065a69 Doc: Add a question to FAQ about QML imports not being found
This results in error messages and missing functionality.

Change-Id: I041ea8e61f3b4cd113964d2c5dfc609e6581c2f7
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Marco Benelli <marco.benelli@qt.io>
2018-06-01 13:08:37 +00:00
Leena Miettinen
af1bd287a8 Doc: Update the FAQ
The Welcome mode is no longer implemented using Qt Quick 2, so the
problem arises later, when opening Qt Quick Designer or QML Profiler.

Change-Id: Ifbe50bdb9cfc1709842413d271d96378549eb673
Reviewed-by: hjk <hjk@qt.io>
2018-06-01 11:30:39 +00:00
Leena Miettinen
071a09f312 Doc: Update screenshots of Kit options
This is now a top-level category, so the tab order is different
from before.

Task-number: QTCREATORBUG-20511
Change-Id: I0978dd12f1ea55cb4cb97f2635b9c1ef7b623c5f
Reviewed-by: Robert Loehning <robert.loehning@qt.io>
Reviewed-by: hjk <hjk@qt.io>
2018-06-01 11:30:22 +00:00
Leena Miettinen
6c9343c2bb Doc: Describe "Auto-create build directories" CMake option
Change-Id: I36bda5ae451af8cebfb0c8435c017c7773875211
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-06-01 10:30:25 +00:00
Leena Miettinen
0666b11c01 Doc: Describe new kit options
Update the screen shot.

Task-number: QTCREATORBUG-20511
Change-Id: Ic21761cae6ba2ac5e29653d3ba27b520256ca66f
Reviewed-by: Tobias Hunger <tobias.hunger@qt.io>
2018-05-31 12:06:59 +00:00
Nikolai Kosjar
b1ecfe5c5d Clang: Add "Outline of symbols" to implemented services in doc
Change-Id: Ic1dd6f644b60c5bdcbbb2a75ca119311c5f827df
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-05-30 13:07:24 +00:00
Leena Miettinen
fe09fc239c Doc: Add :<range>sor[t][!] to the list of FakeVim CLI commands
Change-Id: Ibe0b9724cdb242c869cdef662cc617d393cd4f4b
Reviewed-by: hjk <hjk@qt.io>
2018-05-30 06:52:46 +00:00
Leena Miettinen
019f3c0d6c Doc: Describe new filters in Issues pane
... for Clang Code Model and Python.

Change-Id: I4a1844137874c5c2c4bd3f0348879cf4c40ceda0
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@qt.io>
2018-05-29 08:33:04 +00:00
Leena Miettinen
80dd54ec8b Doc: Describe the Cancel Build button
Change-Id: I448cd01cd9d2741ff8a4dcb962ddbf3d839f0aa8
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-29 06:49:29 +00:00
Leena Miettinen
79b958b02e Doc: Describe Previous Bookmark and Next Bookmark functions
Describe the Bookmarks menu options and the buttons in the
Bookmarks view. Update and add screenshots.

Change-Id: I5a72fd1679fe1c3d674dc703884e3e9c3a663a47
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-28 13:46:47 +00:00
Leena Miettinen
8d9942300f Doc: Mention the Context Help context menu item
...for getting context sensitive help for a class or function
(an alternative to pressing F1).

Change-Id: I5c742f13a7eedde39d75cdb35c7ae860ac531567
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-28 13:02:54 +00:00
Nikolai Kosjar
5e8ad2ca45 Doc: Update clang code model page
Since the clang code model is enabled by default now, remove the text
that describes how to activate the plugin.

Change-Id: I2e2c5d84ca00302cb5f9f15dceaab48279fce75a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2018-05-28 06:34:13 +00:00
Leena Miettinen
286d8d591a Doc: Describe the New Search option in Search Results pane
Task-number: QTCREATORBUG-17870
Change-Id: I51a7432d587ff426b20ea4212fd605c367e3d915
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-25 14:44:59 +00:00
Leena Miettinen
6b071f5e36 Doc: Describe mode selector styles
Task-number: QTCREATORBUG-18845
Change-Id: Ib9a7ae38f11624b5c22b4e7c889736cf4405a839
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-25 12:40:25 +00:00
Leena Miettinen
b1fcbfecce Doc: Add a link to a site map (TOC) listing all topics
Change-Id: Ibb71a67874d0146298c6bbed420549660426e0ca
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-25 09:30:31 +00:00
Leena Miettinen
de5db2d664 Doc: Describe new File System view functions
Change-Id: Iaa2592f7ae7188bbd136558c208c4523c25b3dfe
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2018-05-25 08:55:56 +00:00