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>
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>
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>
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>
Start with an initial value 'macOS' and use in uncontroversial
places in the docs. Some explicit references to older versions
are untouched in this patch.
Change-Id: Ibea4115c45fc2ff2c9a0518d92797df26fd4138f
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
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>
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>
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>
- Add missing sourcedir (../api) to get landing page and other
documentation generated.
- Remove invalid sourcedirs (Find and Locator plugin directories
no longer exist).
Change-Id: I125e86702eaded08de342e103970281984f449d4
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
A default indent of 1 was defined for code snippets. It was overridden
by the template, and most likely left there as an oversight. Now, with
QDoc and the templates from Qt 5.6 it does have an effect, and makes
the style look worse and copy-pasting code more cumbersome.
Change-Id: I37a0facd4c03566eaf295a2cc391fa328f50c14d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
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>
"Debugging and Analyzing" is now "Testing", because
autotests are also described in this section.
Change-Id: Ied1de78d630e4e7faa39d343475b5e493b5e89c7
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
It has been deprecated and was only used as an example.
Change-Id: I4e483e2f86b32476e4b88c9c3eecb7eeffa42e72
Reviewed-by: Eike Ziller <eike.ziller@theqtcompany.com>
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>
Based on the Qt Quick Controls UI Forms example.
Change-Id: Iec42b7559161f980e4f482c63bfc40a22f5e77f8
Reviewed-by: Tim Jenssen <tim.jenssen@theqtcompany.com>
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>
- Add a copyright notice (required for projects external
to Qt in the new template)
- Add an .html file with sidebar content
Change-Id: I2c9d965698aa2d2ed01426510b16916ed4fef8cf
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Quite a few things have changed and the documentation should describe
them correctly.
Change-Id: I21a1f81022f21500c069b641744a37eef9eaa6b9
Task-number: QTCREATORBUG-12590
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
-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>
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>
The Qt Simulator is no longer mentioned in the docs.
Change-Id: I8730e45c75f2e69dadc053ebfa205aa7b6eef5fd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Replace with "Qt distributions" or "installers" or rewrite
in some other way.
Remove references to installing Qt 4 SDK, because it is
no longer available for downloading.
Change-Id: I291f82702e21d953f2efbb0e634d6454b4bc17b9
Reviewed-by: hjk <hjk121@nokiamail.com>
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>
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>
-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>
Can be enabled by passing LICENSE_TYPE=enterprise to qmake.
Change-Id: I49044c2425a056980b6e9f8377e6a33c1beaca5a
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
The doc sources are no longer used for single-sourcing.
Change-Id: I934c88c19646d84b4de3c5787234148f947c4489
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Knowledge why internal API was explicitly enabled is lost.
Change-Id: Ie35b31f624be413405bf2f28cf97822aa687bb3d
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
The \i and \o commands were replaced with \li and
\bold was replaced with \b in QDoc for Qt 5.
The \input command was replaced with \include in the docs.
Change-Id: I257d1bebb8ebc739ca20e0d29fcf0406ecb14534
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
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>
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>
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>
The HTML.templatedir is no longer used in Qt 5. Instead, the files
are resolved relative to the referencing qdocconf.
So we set the templatedir to the path of the qdocconf (for Qt 4)
and change the references to be relative to that path.
Also, it's HTML.extraimages in Qt 5, instead of extraimages.HTML
Task-number: QTBUG-28304
Change-Id: I5b253ea9fac5825c49f74460df188a7fca5c89cd
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
