Commit Graph

14 Commits

Author SHA1 Message Date
Kai Koehne
92e396926e doc/global: Remove references to Qt 5 in comments
Change-Id: I15d91e2f593551879b1b3b5adf58c536abf8467b
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
2020-11-19 17:27:30 +01:00
Jerome Pasion
b11cb96f28 Doc: Fixed QDoc's navigation mechanism.
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>
2013-06-25 14:03:24 +02:00
Topi Reinio
284958c222 Doc: Support for meta-content in manifest XML files
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>
2013-02-15 17:48:36 +01:00
Jerome Pasion
5e5bc779c3 Doc: Updated HTML copyright year to 2013.
Change-Id: I9e750fa78ea552f6f906afb4dc52373f3eac2d39
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2013-01-22 14:43:14 +01:00
Jerome Pasion
fac02ddc39 Doc: Restored CSS images for the offline HTML and QCH build
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>
2012-12-10 23:10:43 +01:00
hjk
0e7ba5e763 Fix path to style/offline.css in qt-module-defaults.qdocconf
Change-Id: I203cca8041c44116bef7021837ad21bd85e86b4c
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-11-30 18:37:15 +01:00
Jerome Pasion
e508e26915 Doc: Adding online styles
-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>
2012-11-19 13:51:18 +01:00
Jerome Pasion
80f91f4e1b Doc: Adding \externalpage links to qtbase/doc/global
-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>
2012-11-13 14:14:29 +01:00
Jerome Pasion
ec1cd70a71 Doc: Adding style/offline.css to the global QHP configuration.
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>
2012-11-07 15:59:58 +01:00
Jerome Pasion
f0775a5b25 Doc: Consolidated the QDoc variables.
-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>
2012-10-26 14:59:49 +02:00
Jan Arve Saether
2b6edec5c2 Doc: Added landing-, examples- and C++ class list-page to qtwidgets
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>
2012-10-19 17:42:14 +02:00
Jerome Pasion
1933b711b6 HTML template: Updated copyright information from Nokia to Digia Plc
Change-Id: Ib4315aa0a7a92e3b36da855c2787b60cc3c332fe
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: Iikka Eklund <iikka.eklund@digia.com>
2012-09-27 02:29:35 +02:00
Frederik Gladhorn
ca9d32faf4 Add Q_PRINTSUPPORT_EXPORT to qdoc ignores.
Change-Id: I0b8676a14133baf818ec12cda77dcb0670b5ee85
Reviewed-by: Qt Doc Bot <qt_docbot@qt-project.org>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@nokia.com>
2012-09-18 00:59:08 +02:00
Casper van Donderen
c3523bdde7 Doc: Centralize more common settings in 1 global qdocconf.
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>
2012-09-11 09:35:28 +02:00