Currently it is used by the Enginio module, but it
will be useful in other modules as well.
Change-Id: If8b458bfedb0da0d4b8c14484710c1a2ade502dc
Task-number: QTBUG-41254
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
A topic URL has changed in the Qt Creator documentation.
Change-Id: I3c6b5fbcb670d7a637a309b7a77a3da815a795ca
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This commit adds id tags with the anchor reference as the value
to html entities for documentation section titles and function
signatures, properties etc. for both C++ and QML documentation
pages.
Together with new CSS rules, we can dynamically highlight the
title that the user clicked on. This helps to locate the item
of interest on a crowded page or when the page cannot be
scrolled down enough to place the selected item on top.
Change-Id: I7d1db2ed4e12779e1a9e571996ee65c3befa4e7a
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Move the line that adds the external page definions into its own
separate include file.
This prevents the files from being included in every Qt
documentation module by default, needlessly duplicating the
information. Currently only the QtDoc module (and modules that
depend on QtDoc) need it.
Task-number: QTBUG-41003
Change-Id: Ie2ddd3a645ea731787daacfffb3068cb36c79c9a
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
In the offline template, the floating elements in the navigation bar
interfere with the layout of any elements displayed next to it. In
particular, subtitles used for example files and nested class
documentation have wrong horizontal position.
This change adds CSS for the subtitles to be displayed as block
elements, and disallows floating elements on the left side - TOC
is still allowed to float on the right side.
Task-number: QTBUG-40924
Change-Id: I89be3844985e6cf95263db575768034d9270d140
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Since the \br was promoted from a macro to a QDoc command, its output
has been enclosed in extra paragraph end/start tags, adding to the
visible vertical space.
This change fixes the issue by not closing the paragraph when QDoc
encounters a \br command.
Also removes the now-obsolete \br and \hr macros, as they are both
proper commands. \BR and \HR substitute macros are kept.
Task-number: QTBUG-37361
Change-Id: Iabbefb6e79268419792ccba42386f6342ccd175d
Reviewed-by: Martin Smith <martin.smith@digia.com>
-The online URL doesn't use the minor version
anymore and this makes the non-Qt projects
depend on the existence of redirects.
Change-Id: I5b2bef16957ca307060600b7bf25eb1d55f2c998
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-individual Qt 5 modules have the same URL and it can be inherited
from doc/global
Change-Id: Ie53fe7509a4f906740512e290e263d34ba3f2ee6
Reviewed-by: Martin Smith <martin.smith@digia.com>
-"HTML.tocdepth" variable controls depth value.
-setting to "0" disables table of contents.
-sections 3 and 4 usually don't have descriptive titles
to warrant their listing in the table of contents.
-table width and CSS (online and offline) don't support wide entries.
-Config class' getInt() function now returns -1 if a variable is
not set.
-for Qt 5 and projects which use html-config.qdocconf, tocdepth is
set to "2".
-added variable documentation.
Task-number: QTBUG-38967
Change-Id: Ibd612f5b846ecb9c4b575e7ac11605c6efd2b77c
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Remove highlighting for examples with known problems, and
examples that don't work on all platforms. Add highlighting
for improved ones and prominent examples that demonstrate
new features.
Task-number: QTBUG-37203
Change-Id: Ida7fd28573dfebe6e4e3320ef83782654632219e
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-helps the QDoc parser read C++ API when the macro is excluded.
Task-number: QTBUG-33360
Change-Id: Ic7e86c0d1cec4a1960d20b1c92c4b60396eb3ea6
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
The CSS for unordered lists placed a nested list
vertically too close to its parent list item.
This commit fixes the issue.
Task-number: QTBUG-38217
Change-Id: Ia5003f2aab197f455ed5bbea2e1ee2e6475aaffe
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-modules that use the qt-module-defaults.qdocconf have access to the
.qdocinc file.
-content about running examples can be used by example documentation.
Task-number: QTBUG-33597
Change-Id: I88d93a9982c05a24b4f7ac1b2cfb3293e56031b2
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
This update fixes part of QTBUG-37719. Q_DECL_FINAL is a
macro that is documented, but links to the documentation
for it were not created. The problem was that Q_DECL_FINAL
is actually used in the Qt sources, but it was not listed
in the Cpp.ignoretokens clause in the qdocconf file. This
update just adds it to Cpp.ignoretokens.
Task-number: QTBUG-37719
Change-Id: I62945df4976b21b67084e6de25e25bbc4c92f89f
Reviewed-by: Sze Howe Koh <szehowe.koh@gmail.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
The "Creating an Android Application" tutorial was
adapted to also apply to iOS and renamed as
"Creating a Mobile Application". The page name (HTML)
was changed as well.
Change-Id: I445a258e21242b3c19b8fd83b35d24514ffc94cc
Reviewed-by: Sergio Ahumada <sahumada@blackberry.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This fixes most of the \fn-not-found errors in QtCore.
Change-Id: I61a48646c6341cb3310bbb83f190a15e9225fd14
Reviewed-by: Jędrzej Nowacki <jedrzej.nowacki@digia.com>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Beautifier and Windows Runtime plugins were added for 3.1.
Change-Id: I6ad16aa004e4ea2c468d2dc07e3d6142e63ff396
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
That expand to __attribute__((const)) and ((pure)). A "const" function
is a function allowed to examine only its arguments, without modifying
them. A "pure" function is also allowed to read memory.
Currently working only on GCC/ICC/Clang, MSVC lacks these.
Change-Id: Ie60a0847b193fb88e116f61611dc571296a3df1c
Reviewed-by: Marc Mutz <marc.mutz@kdab.com>
-new layout for landing page
-updates to title sizes and changes to footer
-fixes to general paragraph issues
-index.qdoc changed in qtdoc repository
Task-number: QTBUG-36411
Change-Id: Icb4fb0374e474137686f4cb67c64dc0249fef2c4
Reviewed-by: Martin Smith <martin.smith@digia.com>
-new page called "Creating an Android Applicaion"
Change-Id: Ibe17f7c96aee3fe6c549a27d3b0f2b93cc0a5453
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
-Qt NFC and Qt Bluetooth no longer need them
Change-Id: Ie198cfc3d5171c04cdd2c36b83ec5f1718e16972
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Alex Blasche <alexander.blasche@digia.com>
Tested the examples that are tagged for
user experience and relevance for mobile devices, and
updated the list accordingly.
Task-number: QTBUG-34805
Change-Id: I1ccd23fa626deb42c0fea4e03a2bf7a8dd2a856c
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
We have it on function declarations and it gets a bit lost...
Change-Id: I19ba2e760f3714c26e78c3d8fd2570af3dcd136e
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@digia.com>
Some of the examples that where tagged with "android" are no longer
supported (e.g., video widget), others just don't work.
This patch replaces those that have equivalent examples that are known
to work, plus some new ones that where missing (Camera, AndroidExtras
and AudioOutput).
Change-Id: I9173ab31d0ef0b55613fd5342e7d2e6d95d4d980
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
Up to now, the feature classe Uniform Initialization was subsumed by the
Q_COMPILER_INITIALIZER_LISTS flag together with support for
std::initializer_list.
This caused at least two problems:
1. On QNX, the standard libray does not ship <initializer_list>, even
though the compiler (a GCC 4.6, IIRC) supports it. But since there
was only one Q_COMPILER flag for both, support for the compiler-only
part of the feature had to be disabled, too.
2. MSVC 2013 supports initializer lists, but has a bug that renders full
uniform initialization support, as required for QUuid, useless.
By splitting the feature into two, we can separate them better, and do
so in QUuid, which is the only class that currently takes advantage of
uniform initialization (to provide constexpr constructors).
Since Q_COMPILER_INITIALIZER_LISTS worked as a flag for uniform
initialization so far, with the two known exceptions above,
UNIFORM_INIT is defined whenever INITIALIZER_LIST is, except that
I don't revert UNIFORM_INIT on QNX as I do for INITIALIZER_LISTS
and that I expect the MSVC 2013 features to set INITIALIZER_LIST,
but not UNIFORM_INIT.
Task-number: QTBUG-34705
Change-Id: I81916e950a0f3aab3de7977e0326d2de3d31b14c
Reviewed-by: Yuchen Deng <loaden@gmail.com>
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
Removed links to obsolete pages (some pages were combined and
some were removed), added links to new pages, and changed a title.
Change-Id: Iaf0e3adf2edaf048a8bb7e26b3cfd45c4680de2d
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-footer is left aligned and smaller text.
-footer contains fewer <div> which were not used.
-CSS rules for footer changed to accommodate new specifications.
-information not relevant in offline builds taken out.
Task-number: QTBUG-33802
Change-Id: Icc57bad9ead8ce812d5df8e72a7bac8c22831b5f
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: hjk <hjk121@nokiamail.com>
These example projects are plugins that cannot be run
stand-alone. Remove them from the list of examples
in Qt Creator's Welcome mode.
Task-number: QTBUG-33889
Change-Id: I65b5b91a6c5b73616c10c91b7ab3f5bddbe6e6fe
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
This is required for functions in the QtWin namespace.
Change-Id: I6c38c8ef262377050a75861435da381863340f33
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
These examples are not in Qt Multimedia, but in
Qt Multimedia Widgets module.
Change-Id: I44fe0f10aa3229068646ff226551398a0cb3e27e
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Add examples that do not have any images in their documentation
into manifest-meta qdocconf file, and define a generic image to
use as a thumbnail in Qt Creator Welcome mode.
Task-number: QTBUG-31314
Change-Id: I1625bf15cbaa53e940a07b1828dc77ca5ba45ccc
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
These macros were previously defined for QDoc manual.
This change adds them to global macros.qdocconf so
they can be used everywhere.
Change-Id: I4fdf5a103ecfb356719951a7d0c6fbd35c887744
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
QT_MUTEX_LOCK_NOEXCEPT is defined as Q_DECL_NOTHROW
on Linux, the latter being already ignored by qdoc.
This change ignores also the former, clearing
related documentation warnings.
Change-Id: Iaeee7a851b4b6d3c2e3308c1b376406c11271807
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Change-Id: If725ac4e523d56a8dc274f8d6b53c0c34064ca06
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
