The HTML pages need to display minimal navigation such
as a link to the module landing page or Qt 5's index.html.
-new variables available in qdocconf files:
navigation.landingpage
navigation.homepage
navigation.cppclassespage
navigation.qmltypespage
buildversion
The navigation variables are for the new navigation bar.
The buildversion variable is to insert documentation build
information into the pages.
Note about compatibility with Qt Creator docs:
The HTML template files for Qt Creator is retained to keep
Qt Creator compatible with 5.0.x and 5.1.x.
Change-Id: Ibb4d7cada19644204457d822b6b77b2aa7b70f8d
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
This change enables the developers to list all the tagged
examples on the Qt Creator welcome screen using the "android"
tag.
Task-number: QTBUG-30173
Change-Id: Ic09183eb441497506b2d35f0d83ecd5d73d724f5
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Christian Stromme <christian.stromme@digia.com>
Don't highlight the example until it's updated to use a new version
of the Twitter API.
Task-number: QTBUG-31745
Change-Id: If7f9ac3391c549f48cfebcdbe6bdcd12eb4a3e13
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Use the manifest meta-content system to add suitable tags for Qt WebKit
examples.
This enables users to filter for them in Qt Creator Welcome mode by
typing 'webkit'.
Change-Id: Ie9b5f6ff9f455dd3d8f7c64e5f73e30ff021f208
Reviewed-by: Kai Koehne <kai.koehne@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Add an 'isHighlighted' attribute to selected examples to bring them
to the top on Qt Creator Welcome mode/Examples tab.
Task-number: QTBUG-29354
Change-Id: I6c72c11f1f8359d889649ff5b7f91e5c4de583bd
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-the externalsites from qtdoc is being removed and the new copy is in
qtbase/doc/global.
Change-Id: I8f509acf05c0e1f399205daf4e4831cf46475746
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
-This should allow any Qt 5 module which inherit qt-module-defaults
to link to the Qt Creator Manual.
Change-Id: If413fe299fa604d16c06fa261024c1a12be24b09
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This token must be ignored by qdoc's hapless C++ parser.
Task-number: QTBUG-29444
Change-Id: I02a0c5926a3fa6284648a632341e38614a237a30
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
This should avoid QDoc warnings when the macro
is used with the signals and slots.
Task-number QTBUG-30105
Change-Id: I8d1b32854c15ff07e6ece7b326be38666ae29c3f
Reviewed-by: Shawn Rutledge <shawn.rutledge@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
-added style for JavaScript code blocks
-code blocks is scrollable when viewed in a narrow window
-improved alignment of table of contents
Change-Id: I45acdb4c7aa0ae57fe030e7e68a230c1a7d41b8f
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
This change makes qdoc support additional attributes and tags written
to example/demo manifest files. The goal is to enable highlighting of
selected items, as well as having additional content to make searching
for specific categories work better in Qt Creator welcome screen.
This meta-content is stored in manifest-meta.qdocconf, which is loaded
globally for all modules.
Tag handling is also changed to use a QSet to eliminate possible
duplicate tags.
Task-number: QTBUG-29354
Change-Id: I2c4b2dff6229172efbecc2bfc1c269017edc4d56
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
This macro is useless from Qt 5.1 on, so:
- Remove comment about using QT_BEGIN_NAMESPACE after QT_BEGIN_HEADER
- There is no need to blacklist these in qt-cpp-ignore.qdocconf
Change-Id: I2c3ceb3d77d294a606b87f7486071a2350b3d42f
Reviewed-by: Laszlo Papp <lpapp@kde.org>
Reviewed-by: hjk <hjk121@nokiamail.com>
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-value copied from qt-project.org
-more room between lines of text and the list at the landing page.
Change-Id: Iee995325ded0c803feca44d112c5e73a024917bb
Reviewed-by: hjk <qthjk@ovi.com>
Revert "Doc: Removing entry in CSS for adding icons to HTTP links"
This reverts commit ceb2799163.
Also:
-edited image to use Qt Project brand colors
-removed breadcrumbs from CSS
Change-Id: I3c2e655f8eac463677b20b68bc2ffa0efd2fd468
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
-padding should be the same as C++ code snippet.
Change-Id: Idba44d252f411f70b6957161b83626811c1c69f2
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
This is a temporary solution to
QDoc bug https://bugreports.qt-project.org/browse/QTBUG-28307
The links will not have the icon.
Change-Id: Ib81bcc9c55cd5f403c85fdd38c0ee71219091e76
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
Change-Id: I398a9e46fd9c4beacd9e8554dab544154e48b870
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
-used Qt Project colors
-changed margins and paddings
Change-Id: If7a533ac3a32debbaca7b403aa68290c2b9aab2c
Reviewed-by: Martin Smith <martin.smith@digia.com>
-Has the Qt logo
-For generating the archives and online snapshot
Change-Id: I88d1d6335c0ba600a62868a25fadaed8a751f2b4
Reviewed-by: Martin Smith <martin.smith@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
No longer needed as the paths are resolved relative to the file.
Change-Id: Id4012336b7de00a5dcf8686e44f7a972e2b8b284
Reviewed-by: Martin Smith <martin.smith@digia.com>
-Moved from qtdoc repository
-included in the default configuration for each module
-grouped links
Change-Id: I544d9232950f50ae9fb877c1a0166ab157f70942
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
All modules wishing to use the default style will get the offline style
in their QCH files.
Change-Id: I37f41f72be7946a6473e6d56d4ef2f6d7c454f47
Reviewed-by: Martin Smith <martin.smith@digia.com>
-Modules only need to include qt-module-defaults.qdocconf
-Sorted the variables.
-The variables still need to be confirmed to be important.
Change-Id: I7b40f665bf6348b668f3bcfd3c5ab4d881ef6aed
Reviewed-by: Martin Smith <martin.smith@digia.com>
The module documentation require these definitions.
Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb
Reviewed-by: Martin Smith <martin.smith@digia.com>
It seems this is the pattern to follow:
landing page: qtwidgets-index.html
examples page: qtwidgets-examples.html
class list page: qtwidgets-module.html
Change-Id: I3e5459fe650178e0398cb43181b594c0f12a170e
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
All qdocconf settings that should be used by all Qt modules are now in
qt-module-defaults.qdocconf.
Change-Id: I2a0315a55db3fcbb0160c4392d2da98611043d83
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org>
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
We should be using the global qdocconf for the common variables. This
change also allows you to just specify -installdir without using a
templatedir.
Change-Id: I207d279d9b5199212e896fc5ccab5c212b1896c6
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
This fixes a couple of qdoc errors on methods that
are declared as nothrow.
Change-Id: I22bcd18253665280a5c1c3a38539dacf8f869c57
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
This fixes a large bunch of qdoc errors in Qt Core.
Change-Id: Ie3c3cebc730081a0927a0998d8937d721719c1c6
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
The CSS for the footer is not completely correct, but at this
time it is better to have something than nothing.
Change-Id: I7371e1e458a2abafcdb0fca5564ad73e209d64c3
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
This change fixes most qdoc errors in QtCore. There are about 900 left.
The main thing this change does is moving documentation from qtcore from
/doc/src to /src/corelib/doc.
Other issues resolved are mis-use of qdoc commands.
Change-Id: I002d01edfb13575e8bf27ce91596a577a92562d1
Reviewed-by: Lars Knoll <lars.knoll@nokia.com>
Reviewed-by: Jason McDonald <jason.mcdonald@nokia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
