Commit Graph

25 Commits

Author SHA1 Message Date
Mitch Curtis
636ee3e91d Doc: rename Tips and Tricks to How-tos
This is based on Qbs' how-tos documentation:

https://doc.qt.io/qbs/howtos.html

I find this format easier to follow, both because of the phrasing of
each section and the fact that it doesn't rely on the table of contents
to list the contents, which is squished into a tiny word-wrapped
section on the left of the page in the online documentation.

Change-Id: I46a0751a55e7f34458392c56e12c2e301adde234
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-10-29 10:24:04 +00:00
Leena Miettinen
999564d393 Doc: Describe using Qt Design Viewer
For running Qt Quick UI projects (.qmlproject) in web
browsers.

Change-Id: Ied9b971755ccef9f94e9e0ffb578d3ecbd0ef6c0
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-10-25 07:56:23 +00:00
Leena Miettinen
b6d071c246 Doc: Describe developing apps for Qt for MCUs
Fixes: QTCREATORBUG-22926
Change-Id: I6c494858bcd637e4ae11ab0e8ea2687fb1eb26ef
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2019-10-18 12:27:00 +00:00
Leena Miettinen
83671ebdae Doc: Chrome Trace Format Visualizer
Fixes: QTCREATORBUG-23024
Change-Id: I8caac6521a9962e64ab09932ab6177099d48086e
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2019-10-07 08:27:33 +00:00
Leena Miettinen
99c0d3332e Doc: Add info about building apps for the web
Users have to install Qt for WebAssembly and the tool chain,
as well as add a kit.

Fixes: QTCREATORBUG-22927
Change-Id: Id22d5fb5e7d9e676d77f3f80880030cb9c1f61c7
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2019-09-18 06:56:04 +00:00
Leena Miettinen
526163cc16 Doc: Add info on Live Preview
The documentation was moved from the Qt Design Studio repository
and edited to make it applicable to Qt Creator, too.

Change-Id: I3072fc712b5ee002cd6e7486927de31f9117d7bc
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2019-07-11 12:51:31 +00:00
Leena Miettinen
8d0cd98d4d Doc: Move Timeline editor docs to the Qt Creator repository
Reorganize the Qt Quick Designer docs.

Change-Id: I844f2ffa6c8337eef1d9aa5dbd23610c706a8c33
Reviewed-by: Brook Cronin <brook.cronin@qt.io>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2019-05-03 13:55:11 +00:00
Leena Miettinen
cbe053f685 Doc: Divide the User Interface topic into several smaller ones
Update screenshots.

Change-Id: I740607007c7316b755b083056ff0a4f69f6a49e8
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-04-16 14:32:14 +00:00
Leena Miettinen
79e75a8fda Doc: Remove the word "prototype"
For reuse in Qt Design Studio, where the terms will be
changed.

Change-Id: Icbfec3759a3b677df2d166379404a58540d13012
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-01-17 12:53:32 +00:00
Leena Miettinen
fdd8650657 Doc: Describe converting Qt Quick UI Prototypes to Applications
Qt Quick UI Prototype projects (.qmlproject) are used in Qt Design
Studio, but they must be converted to Qt Quick Application projects
for building and running them in Qt Creator.

Add example files and quote code from them.

Task-number: QDS-357
Change-Id: Ib0bf1b342ec54faeca108e5586389730a85b5116
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-01-16 10:59:30 +00:00
Leena Miettinen
626b976949 Doc: Add info about experimental Cppcheck plugin
Change-Id: If65414586c159d7391574523dde67f12ea93a439
Reviewed-by: Sergey Morozov <dev@gres.biz>
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2018-10-19 08:55:47 +00:00
Leena Miettinen
fac917b477 Doc: Describe the experimental language client plugin
Change-Id: I14e227a242dc101f9e535f56da52beddb5bc325a
Reviewed-by: hjk <hjk@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
2018-10-16 09:06:11 +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
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
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
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
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
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
2cf62f2b1a Doc: Describe detecting memory leaks with Heob heap observer
Change-Id: I8f11005c58cafd4239b7c618575aa63954e900aa
Reviewed-by: Hannes Domani <ssbssa@yahoo.de>
Reviewed-by: hjk <hjk@qt.io>
2018-02-01 11:36:15 +00:00
Leena Miettinen
d37e880b3d Doc: Remove information about connecting UWP devices
...because no additional steps are needed to the explanations in
the sections about building and running applications.

Change-Id: I8b60c95ce45f025d696a806ab09d43132607e355
Reviewed-by: Oliver Wolff <oliver.wolff@qt.io>
2017-08-22 07:51:15 +00:00
Leena Miettinen
03dce9a65f Doc: Use the umbrella term "device" for both mobile and embedded
Add a glossary entry for "device" to make changing the definition
easy and link the first occurrence of "device" in a topic to it,
where applicable.

Change-Id: Ia1b8b669b0000eea47d6a7b9860d3329d93a4395
Reviewed-by: Vikas Pachdha <vikas.pachdha@qt.io>
Reviewed-by: Tarja Sundqvist <tarja.sundqvist@qt.io>
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
2017-08-18 14:53:27 +00:00
Leena Miettinen
c438eda6cd Doc: Windows Runtime renamed as UWP
To reflect the change in Qt installers since 5.9.

Change-Id: I685c32c168e95e76ae3d81b87d4d10a5092e7a8a
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
2017-08-16 14:17:17 +00:00
Eike Ziller
cec29f34ea Merge remote-tracking branch 'origin/4.2' into 4.3
Conflicts:
	doc/src/qtcreator.qdoc
	tests/system/suite_general/suite.conf

Change-Id: Ia298b177d6920a1d853e342b62cf98f7c48a278a
2017-03-09 12:14:55 +01:00
Leena Miettinen
0ed42f1c9f Doc: Move the TOC to a separate page that is used as indexTitle value
This fixes the problem that the whole TOC is not visible in the
Qt Creator Help mode Contents view (because it was generated based on
the \table entries, not the \list entries).

Task-number: QTCREATORBUG-10585
Change-Id: I86607e10db7172b2a7492e4ce1660c39390ef9ed
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
2017-03-09 09:13:27 +00:00