Commit Graph

160 Commits

Author SHA1 Message Date
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
Jerome Pasion
7b48954df2 Doc: Applying new qt-project.org style to "online" style.
-added images
-modified template and CSS file

Change-Id: I0d50f940271d6af80ade38f50d4efa2028441dba
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-25 14:03:13 +02:00
Frederik Gladhorn
533820320c Merge remote-tracking branch 'origin/release' into stable
Change-Id: I94bb158562ae6b80a87b40139d7302ea7b9b9aa8
2013-06-20 16:13:38 +02:00
Venu
021264a239 Tagged all those examples that work on an Android device
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>
2013-06-19 17:10:44 +02:00
Oswald Buddenhagen
e80841f113 make images non-executable
Change-Id: I7d6c28e7fd18125c95e56eca2d0d6d67003f9c5d
Reviewed-by: Martin Smith <martin.smith@digia.com>
2013-06-17 15:42:00 +02:00
Topi Reinio
19ed991e56 Doc: Remove Tweet Search demo from the list of highlighted examples
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>
2013-06-15 19:04:58 +02:00
Stephen Kelly
abaaaea041 Update Urls to CMake docs.
Change-Id: Ic6743e8adb8d386fabc20c17c47fd110a47201da
Reviewed-by: Thomas McGuire <thomas.mcguire@kdab.com>
2013-05-20 12:06:48 +02:00
Topi Reinio
2e82e474d6 Doc: Add tags for Qt WebKit examples
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>
2013-05-13 15:39:35 +02:00
Topi Reinio
7fa4af5a97 Doc: Highlight a number of examples
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>
2013-05-08 10:01:17 +02:00
Jerome Pasion
1b91379323 Doc: Copying changes to external pages from qtdoc
-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>
2013-05-07 14:28:43 +02:00
Jerome Pasion
6f87ca2908 Doc: Adding Qt Creator Manual as \externalpage
-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>
2013-04-30 12:45:30 +02:00
Martin Smith
47a9f80dc1 qdoc: Added missing CPP ignore token, Q_QML_EXPORT
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>
2013-04-08 11:35:44 +02:00
Venu
f226e7e631 Doc: Added the Q_REVISION macro to the ignore list
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>
2013-03-24 03:21:09 +01:00
Jerome Pasion
cbe6aafc11 Doc: Various changes to global CSS files.
-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>
2013-02-28 17:14:54 +01:00
Frederik Gladhorn
f4900d340a Merge remote-tracking branch 'origin/stable' into dev
Conflicts:
	src/widgets/styles/qmacstyle_mac.mm

Change-Id: If8326db9e7da3cbf45dbf7475fdff9915c7723b1
2013-02-18 16:14:52 +01: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
57953e0fea Doc: Added margin to the QML API description.
-added a margin to "qmldoc" div class.

Change-Id: I7297aff4de5d41a7e4de14a09c0a70acb8006bb9
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@digia.com>
2013-02-15 17:48:36 +01:00
Sergio Ahumada
1e33f30f75 Remove left-overs of QT_{BEGIN,END}_HEADERS
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>
2013-01-31 20:08:58 +01:00
Frederik Gladhorn
6bf6c12854 Merge remote-tracking branch 'origin/release' into stable
Change-Id: Iaa321deb9e536ce89b87a337b57634f00c770a32
2013-01-22 18:32:47 +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
Sergio Ahumada
48e0c4df23 Update copyright year in Digia's license headers
Change-Id: Ic804938fc352291d011800d21e549c10acac66fb
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
2013-01-18 09:07:35 +01:00
Sergio Ahumada
5efcd5a6c3 Change ftp.qt.nokia.com -> ftp.qt-project.org
Task-number: QTBUG-28156
Change-Id: I0060144f0336791933205355b125251ccba73b3e
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
2012-12-18 23:13:35 +01:00
Jerome Pasion
f6e9d1c260 Doc: Removing extra included images in the HTML online build.
-images not needed and removed.

Change-Id: I917544dcc9e3cf959b1f8f2723cf4709cdc96a46
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-12-18 19:32:14 +01:00
Jerome Pasion
529110343d Doc CSS: Edited CSS line-height of paragraphs and landing page.
-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>
2012-12-11 16:27: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
Jerome Pasion
3aee20d4ab Doc: Updated CSS style for QML code snippets
-padding should be the same as C++ code snippet.

Change-Id: Idba44d252f411f70b6957161b83626811c1c69f2
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2012-12-05 17:29:46 +01:00
Jerome Pasion
ad4de55eb4 Doc: Fixed online HTML template
-missing a slash

Change-Id: I866e7438fe67a7a78eefa57379a8d5cd99537a66
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-12-03 11:44:02 +01:00
Jerome Pasion
3d4729a377 Doc: Adding empty tags in the HTML
Change-Id: I7251b77b645a2085d25443826aa2b9550a373d88
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-30 23:56:15 +01:00
Jerome Pasion
ceb2799163 Doc: Removing entry in CSS for adding icons to HTTP links
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>
2012-11-30 18:38:49 +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
85e77b3e17 Doc: Modified CSS according to a graphic designer's recommendations.
-Landing page in qtdoc uses the CSS classes.

Change-Id: I05efae40d4d6d1802585c129a0a12b2af7eee5e7
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
2012-11-30 00:49:49 +01:00
Nico Vertriest
8c0787a8a9 Added link to Html5 Web Database API
Removed trailing whitespace

Change-Id: I98e57b23dbd037bea3b9f5f67fee70110207e3e0
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-27 19:31:21 +01:00
Lars Knoll
c19c92e26a Fix link to licensing page
Change-Id: I398a9e46fd9c4beacd9e8554dab544154e48b870
Reviewed-by: Sami Makkonen <sami.makkonen@digia.com>
Reviewed-by: Paul Olav Tvete <paul.tvete@digia.com>
2012-11-27 15:04:00 +01:00
Nico Vertriest
526bac5f69 Added reference to W3C's XML specs
Removed 's from title

Change-Id: I7c44279aab02edd26e454da5f59f4a9a19eab18a
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-23 17:04:00 +01:00
Jerome Pasion
2862697e90 Doc: Various modifications to the online and offline stylesheets.
-used Qt Project colors
-changed margins and paddings

Change-Id: If7a533ac3a32debbaca7b403aa68290c2b9aab2c
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-21 11:03:48 +01:00
Jerome Pasion
cb09767744 Doc: Changing titles in HTML template.
-Easier to differentiate the links.

Change-Id: I9294affcdbf037d91d94fa707449d78fac01bcbb
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-20 09:00:42 +01:00
Jerome Pasion
fbbcea907f Doc: Adding subtitle to the online snapshot HTML
-other fixes to the HTML template.

Change-Id: I85070c615796c4342a89cc730ab2ca8ab51dd5e6
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-11-19 16:10:18 +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
6e345bbfc3 Doc: Removed "class=" in an /div.
-not valid XML

Change-Id: I832490e87113d9143b2280127b539c68a46b0e94
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-11-16 18:23:42 +01:00
Jerome Pasion
46b28abc90 Doc: Removed "templatedir" from qdocconf file.
No longer needed as the paths are resolved relative to the file.

Change-Id: Id4012336b7de00a5dcf8686e44f7a972e2b8b284
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-16 11:51:24 +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
b60c76fa09 Doc: Fixing templatedir paths according to the fix to QTBUG-27878
Change-Id: Ib95be5267514e4afadad4f6fbfd48514a7552227
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-09 15:30:39 +01:00
Jerome Pasion
8c7095969f Doc: Adding necessary HTML elements in the HTML template.
-needed by qt-project.org
-won't affect the qch style

Change-Id: I720a5cae2ea12e8a3dd81ce10b7c003981d61cd8
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-11-09 13:28:16 +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
3c93124536 Doc: Placed missing '\'
Change-Id: I311ea81e2cdd0069f2a93758c3cd38bc75ae0b54
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 13:18:00 +01:00
Jerome Pasion
968581724d Doc: Integrated ignoretokens and ignoredirectives from Qt Multimedia.
Sorted the entries

Change-Id: I6e1716c899e2f7e5360571ccfbde5aaf798d65af
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-11-07 12:45:39 +01:00
Jerome Pasion
1bbcd2ca30 Doc: Added three column layout in CSS file
Change-Id: I8a7c4538ff7eafb3dd23423c1735e27342b6391c
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>
2012-10-29 17:28:28 +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
Jerome Pasion
b065aa9c99 Doc: Adding base macros and other QDoc definitions
The module documentation require these definitions.

Change-Id: Iecef3df5edad761d8c5f67b14783e13952ab2dbb
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-10-26 12:58:03 +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
Casper van Donderen
2e7f06c9bc Doc: Simplify qtbase qdocconfs.
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>
2012-08-31 01:16:56 +02:00
Frederik Gladhorn
c3b9db438a Sort qdoc ignores.
Change-Id: Icada1b073f12273fe8d7712a82a94bc7f3595d8b
Reviewed-by: J-P Nurmi <j-p.nurmi@nokia.com>
2012-08-21 16:20:25 +02:00
Lars Knoll
33b2984271 Add Q_DECL_NOTHROW to the tokens qdoc ignores
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>
2012-08-18 08:34:53 +02:00
Frederik Gladhorn
751743af4b Make qdoc ignore Q_WIDGETS_EXPORT.
Change-Id: Ic76ba6260a219f5a7f336e6bc15654bc827dfcd3
Reviewed-by: Jan-Arve Sæther <jan-arve.saether@nokia.com>
2012-08-17 19:41:59 +02:00
Lars Knoll
f73e49808d Ignore Q_DECL_NOEXCEPT in qdoc
This fixes a large bunch of qdoc errors in Qt Core.

Change-Id: Ie3c3cebc730081a0927a0998d8937d721719c1c6
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-08-15 11:38:37 +02:00
Casper van Donderen
653bca19c7 Doc: Add a default license footer.
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>
2012-05-11 17:39:13 +02:00
Casper van Donderen
0bc02fd0d6 Doc: Prepare for building modular QtCore docs.
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>
2012-04-19 07:34:53 +02:00