Commit Graph

43 Commits

Author SHA1 Message Date
Leena Miettinen
aacac48908 Doc: Replace "Qt Quick Controls 2" with "Qt Quick Controls"
- Qt Quick Controls 1 has been removed and most link targets have
  been changed
- Leave some link targets where links would break
- Leave strings that still have the "2" in Qt Creator
- Remove the obsolete dependency (QDoc complained about it)

Change-Id: I05148df3b07b4499f802557252c028b11ca29213
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2019-04-09 07:15:56 +00:00
Leena Miettinen
6ee855a2bc Doc: Describe launching KCachegrind from Qt Creator
...for profile data visualization.

Change-Id: I878ab4a3dfff0fc43903e482603a516514e79c10
Reviewed-by: hjk <hjk@qt.io>
2019-04-05 15:18:21 +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
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
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
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
66a22bb608 Doc: Describe the new toolbar in Qt Quick Designer
Some regularly used context-menu items can now be selected
on the toolbar. Some of the icons are constructed at runtime,
so images are needed for them. Some are in a new location that
has to be added to the configuration file.

Change-Id: Ibfc38ec21ed5526702abf89e64899efa5b978700
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2017-05-04 06:44:03 +00:00
Leena Miettinen
b7d1be77e9 Doc: Remove dependencies to deprecated modules
To suppress QDoc warnings.

Change-Id: Ic1eb077701d9e9bdcaee63af9af8eaff8d2ec26f
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2017-03-23 12:37:10 +00:00
Eike Ziller
33fa4b401c Create a reusable docs.pri for generating documentation
Since we cannot directly use qt_docs.prf since it contains
various Qt specific details, adapt it for use in Qt Creator.
This can then be used e.g. by plugins that are not part of the
Qt Creator repository.

Change-Id: I87511cad74cbcae5cb58087e9a9386130d635aa9
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@qt.io>
2017-03-09 09:30:42 +00: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
Leena Miettinen
d2e99f9e55 Doc: Add docs for SCXML Editor
Change-Id: I563a2a06b101e3954c3365baba4a596ef29517ab
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2016-10-06 14:05:26 +00:00
Leena Miettinen
1d39d8aba7 Doc: Remove reference to obsolete qtquicklayouts.index file
Add a link to the Layout QML type and fix the name of the import
to stop an autolink from being generated to the wrong target.

Change-Id: Id2ca5e418ea6d254813a20f00b6623ff21dda09a
Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
2016-08-19 07:48:16 +00:00
Leena Miettinen
ecbd1fa408 Doc: Update creating components and screens with Qt Quick Designer
Add dependency to the Qt Quick Controls 2 docs

Change-Id: Idcbb856cf38d8867dc781ade572cf18f87983912
Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2016-07-29 12:10:13 +00:00
Leena Miettinen
2ab466ea04 Doc: Describe model and state chart wizards
Add the Qt SCXML index file to be able to link to the module
docs.

Change-Id: Ibd28071cdc3c98c07fb91c73732d809ffed5333b
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2016-07-27 14:21:04 +00:00
Alessandro Portale
a6683575c4 Icons: Move "next/prev", "[un]locked" and "zoom" from Core to Utils
They are needed in the timeline view.
The change in qtcreator-project.qdocconf makes sure
that qdoc still finds the referenced icons.

Change-Id: I812fba8e57d06d93efc00c295467c83c08cd1784
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
2016-05-31 08:51:12 +00:00
Leena Miettinen
4021a2a902 Doc: Use icons from source in the manual
This removes the need to take screenshots of icons.

- Add icon source directories for the .qdocconf file
- Remove screenshots of icons from doc\images (except completion
  icons)
- Copy images that do not have unique names from src or libs
  to \docs\images
- Create images that use overlays and update them in docs\images
- Fix paths and filenames in \inlineimage commands
- Fix text where one screenshot was replaced by two icons

Change-Id: Ib98206890bd15a843566de8d709e45487c70dfbd
Reviewed-by: Alessandro Portale <alessandro.portale@theqtcompany.com>
2016-05-03 14:26:35 +00:00
Leena Miettinen
7ed574945a Doc: add docs for ISO Icon Browser
A commercial Qt Quick Designer plugin for
adding ISO 7000 icons to applications from
an icon library.

Change-Id: I96d740d63bc77da9817ce2d5ccdb1625dbc5caa6
Reviewed-by: Mitch Curtis <mitch.curtis@theqtcompany.com>
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-10-27 14:48:02 +00:00
Leena Miettinen
c4fe977e7c Doc: remove references to Qt WebKit
It has been deprecated and was only used as an example.

Change-Id: I4e483e2f86b32476e4b88c9c3eecb7eeffa42e72
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
2015-08-10 07:39:19 +00:00
Leena Miettinen
b9b1f89ea9 Doc: update the mobile application tutorial
Update text to match the template and UI.

Use the \example command instead of \page to have qdoc
generate HTML files from the example files. This requires
also adding the .pro file.

Add an SVG image to the sources and link to it from the
text.

Change-Id: Ib90798386ee082c9ea2a405b33a4f2a5996a9d2a
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-06-30 07:24:58 +00:00
Leena Miettinen
36173e25ff Doc: add UI Forms tutorial
Based on the Qt Quick Controls UI Forms example.

Change-Id: Iec42b7559161f980e4f482c63bfc40a22f5e77f8
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
2015-06-26 13:10:30 +00:00
Leena Miettinen
db48c49af9 Doc: add a "commercial" icon to commercial-only topics
For purely commercial apps, this is done by using the
template, but Qt Creator is mostly open source, so an
image is used.

Use a \commercial macro with a tooltip and link to the
image.

Change-Id: I5e3df953821551331afef2ec642b482b52ff909e
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
2015-04-08 10:45:50 +00:00
Leena Miettinen
8c472f2074 Doc: experimental Auto Test plugin
Commercial only.

Change-Id: Id2ee9a7765f226c32ec1595e32f4b53ee94d1207
Reviewed-by: Christian Stenger <christian.stenger@theqtcompany.com>
2015-04-08 08:13:08 +00:00
Sergio Ahumada
e84770b794 Adapt documentation URL
Change-Id: I74963a9d4a729450341f4f7a4ae5b3583654ffb8
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
2015-02-18 12:38:23 +00:00
Topi Reinio
ceea1d9f5d Doc: Remove non-existent path from .qdocconf
Path 'snippets' does not exist.

Change-Id: I3cd5a426f4916e7cb5c7868f8bf437de8e59389c
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-08-14 15:48:33 +02:00
Jerome Pasion
026ea56bff Doc: Adding Qt Creator's URL in qt-project.org in qdocconf file.
-can be used for referencing Qt Creator's pages from other
 QDoc projects.

Change-Id: Ifdb82a8995976580876523f5bd6efb688bdfb9b1
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2014-07-04 14:40:49 +02:00
Oswald Buddenhagen
cee04d9ac6 fix building against non-installed qt5 shadow builds
the global qdoc configs may live in the source dir, but the indexes are
always in the build dir.

this will obviously only work for a non-prefix (developer) build of qt,
as a non-installed prefix build is not usable from the outside.

Task-number: QTCREATORBUG-11919
Change-Id: I268af2f075a098ac5fe788a2f85c754dc6e4e8b0
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2014-05-27 10:12:52 +02:00
Leena Miettinen
c0704c2091 Doc: use cross-linking to Qt module documentation
Replace links to "\l{http://qt-project.org/doc/"
with links to topic titles. Remove links where QDoc
creates them automatically based on the .index files.
Add the .index files for the modules that are discussed
in the Qt Creator Manual.

Note: the links will only be generated if the Qt used to
build the docs contains the linked modules and documentation
(.index file) has been generated for them.

Change-Id: Ibe624bf3773e7c854c03ebba4db406be0b4a7b90
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-11-26 11:51:46 +01:00
Leena Miettinen
f7b1dbe92c Doc: point the automatic links to Qt 5 docs
The index files are now fetched from qt5/qtbase/doc.
Removed the qt.index file that came from Q 4.
When building the docs with Qt 4, no links will
be generated automatically.

Change-Id: I0786745f218e4c854e08012664629a7697dcadf3
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-11-06 12:32:03 +01:00
Jerome Pasion
72b06779ab Doc: Get Creator and Extending manuals to use new qdocconf variables.
-navigation variables for Qt 5.2's navigation bar
-buildversion is for including specific build information such
 as branch name and patch version

Change-Id: I4d36f1ea73b8c37ab787d154c9fdd91650305bc5
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
2013-06-25 09:49:43 +02:00
Jerome Pasion
ee9c8dafc3 Doc: WS fix in qdocconf file.
Change-Id: I57767dbf8c5af8f2961136cb9a7ca16dab6fcf5b
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2013-06-24 14:20:09 +02:00
Sergio Ahumada
fb3b01d888 Replace com.nokia.qtcreator with org.qt-project.qtcreator
Task-number: QTCREATORBUG-8189
Change-Id: I1c882f55eed901620ef4944bf1789645b7cff34a
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
2013-02-07 12:40:37 +01:00
Oswald Buddenhagen
276320caac make doc generation work cleanly with both qt4 & qt5
qdoc does not expand variables in include() statements, so we need to
use separate top-level "switch" files.

Change-Id: I3152baa36cb3dee055abdc68c046b445f92e1fb9
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2013-02-06 09:40:03 +01:00
Leena Miettinen
75f1e8a66f Doc: fix missing snippets
Add the path to the snippets folder to the qdocconf file
and fix the paths in \snippet commands in the source file.

Change-Id: Iebabec6919b580e6d1474685777862200d314a83
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2013-01-23 12:42:07 +01:00
Eike Ziller
cf937f09d6 Avoid pulling in "Extending Manual" into Qt Creator manual.
With Qt5, qdoc finds the doc/api/*.qdoc files if the examplesdir points
to doc/, leading to the two toplevel index.html files ending up within
qtcreator.qch

Change-Id: I4ac3c1447c6924c4e292024919d52ddb97e1f8cc
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-12-17 12:47:49 +01:00
Leena Miettinen
836a13a97d Doc: remove space from value of project variable
This is a new qdoc requirement for the project variable in
qdocconf files.

Change-Id: I23d921bac68e3c2948c4193b08a60c756e258ccc
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-05-31 14:21:29 +02:00
Oswald Buddenhagen
4a322099f5 remove double mention of $SRCDIR/src
Change-Id: I4627ba8d3be024ab982088fa58ad63c58d086280
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@nokia.com>
2011-11-09 17:40:37 +01:00
Leena Miettinen
af2cde64a8 Doc: change doc configuration after moving files to subdirectories
Change-Id: I6df3222a92efed43ede601e3f2e6f71b75782d22
Reviewed-on: http://codereview.qt-project.org/5602
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2011-09-27 15:51:39 +02:00
Leena Miettinen
b67c3874b7 Doc: separate MeeGo and Maemo instructions
Change-Id: I2c7a9bce7ee92c59f91fa41f732f3c90a9e100e3
Reviewed-on: http://codereview.qt-project.org/4886
Reviewed-by: Christian Kandeler <christian.kandeler@nokia.com>
2011-09-14 17:08:32 +02:00
Leena Miettinen
63710f04ed Doc: generic Linux device target
Change-Id: I25fef3d823915c1df424da1a6ec7b683d7d38d66
Reviewed-on: http://codereview.qt.nokia.com/1323
Reviewed-by: Christian Kandeler <christian.kandeler@nokia.com>
2011-07-08 12:13:14 +02:00
Leena Miettinen
9426bbe0ae Doc: add version numbers to the doc titles
Change-Id: I2b71cba2ab19a15a834976e3ce953e992ca4b124
Reviewed-by: David Boddie
Reviewed-on: http://codereview.qt.nokia.com/640
Reviewed-by: Eike Ziller <eike.ziller@nokia.com>
2011-06-23 10:51:24 +02:00
Leena Miettinen
f270578cb1 Doc: added FAQ 2011-04-04 11:29:42 +02:00
con
4bf6b02989 Fix Qt Creator version in documentation again. 2011-03-07 20:38:17 +01:00
David Boddie
a20cd34863 Updated the configuration files to use the updated qdoc.
Updated qdoc to remove hard-coded dependencies on style sheets.
Simplified the offline documentation, introducing an offline.css
file to be used for documentation in Qt Creator.
2011-02-11 08:40:55 +01:00