Commit Graph

173 Commits

Author SHA1 Message Date
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
21e8ef1fef Doc: Added a README file for building documentation.
Change-Id: I5987af88f7e8efc1b3c4fb788e5fd985e53b08a1
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
2012-12-05 15:30:07 +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
Samuel Rødal
36e744845d Added \ingroup and \brief qdoc tags to IPC examples.
Change-Id: Ic8fb033597340bfb44ee7e0ca7a3763b36c097aa
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
2012-12-01 08:31:04 +01:00
Oliver Wolff
fa181fc824 Docs: Moved layout example's image do correct location
Change-Id: I85c6812d8d172c92fc4322d4300721e0f45f34e7
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
2012-11-30 23:57:09 +01:00
Paul Olav Tvete
e62198967c Fix links for threading examples
Change-Id: I498936e91e3bbf5658ea9f3f0eb33cff271a1d62
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2012-11-30 23:56:53 +01:00
Oliver Wolff
af385b3bc6 Docs: Moved mainwindow example's image do correct location
Change-Id: Idc22e18aa73fed293f629bdccc438567298f1274
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
2012-11-30 23:56:27 +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
Eskil Abrahamsen Blomfeldt
def3285615 doc: Add touch input examples to correct group
Make them appear in list of touch input examples.

Change-Id: Ia5f489e28771f0a272da9ec7b61de186ca305e36
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
2012-11-30 18:43:49 +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
Paul Olav Tvete
d25bd0c37e Fix docs for Drag and Drop examples
Change-Id: Ic1622b64603f7634b697bd7d8412dcc9f1a8c3fa
Reviewed-by: Gunnar Sletta <gunnar.sletta@digia.com>
Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
2012-11-30 18:37:35 +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
c808dd2745 Merge branch 'master' of ssh://codereview.qt-project.org/qt/qtbase into newdocs
Change-Id: I7e6cee190a341901dfbf8effb54ebccb91bf7a17
2012-11-02 14:41:27 +01:00
Sergio Ahumada
7539fa9143 CONFIG+=uitools is deprecated. Use QT+=uitools instead
Change-Id: I45105e5e1dde614d90b1fb392b6e01e698c27a7f
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
2012-10-31 19:56:55 +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
Iikka Eklund
be15856f61 Change copyrights from Nokia to Digia
Change copyrights and license headers from Nokia to Digia

Change-Id: If1cc974286d29fd01ec6c19dd4719a67f4c3f00e
Reviewed-by: Lars Knoll <lars.knoll@digia.com>
Reviewed-by: Sergio Ahumada <sergio.ahumada@digia.com>
2012-09-22 19:20:11 +02:00
Frederik Gladhorn
d1f74b8ddf Move examples to proper location.
Change-Id: Ib808f5d99cb8217f8786411b531fa5bc7fa5250a
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-09-21 19:59:16 +02:00
Frederik Gladhorn
d16c565ca6 Move opengl/wid/net example docs to proper folders.
Change-Id: I846439a9cf7ad965ed27a00f98dbc4ff97abe73b
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
2012-09-21 19:59:06 +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
Samuel Rødal
65f5909df2 Moved gui example documentation to the proper location.
Gui example documentation should be in examples/gui/doc/

Change-Id: I3cd196a2bb5d76b6e275f336b29a2ad1811159dd
Reviewed-by: Frederik Gladhorn <frederik.gladhorn@nokia.com>
2012-09-01 11:21:46 +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
Samuel Rødal
f3b45ffa61 Added OpenGL example and documentation.
Change-Id: I2d9d4e52caf0a39fef9648d8a9e83a0c1328f650
Reviewed-by: Paul Olav Tvete <paul.tvete@nokia.com>
2012-08-29 16:53:00 +02:00
Frederik Gladhorn
9a13bffa29 Move address book example images to proper location.
Change-Id: Ib106445c7a68fb1a1fd2d2c6d568681d83b712c9
Reviewed-by: Martin Smith <martin.smith@nokia.com>
2012-08-28 23:34:25 +02:00
Frederik Gladhorn
6321b5847a doc: remove links to Qt Designer
Designer is in the tools repo, we cannot link there.
Mentioning the name should be good enough.

Change-Id: I55193aa31e60ae266a8890f706c332a63ed3610d
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-08-28 21:07:51 +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
Gabriel de Dietrich
4410e66f45 Making trivial snippets inline
Change-Id: I8d8b5586579d3ee460b234b5a09462586ac1cfd0
Reviewed-by: J-P Nurmi <j-p.nurmi@nokia.com>
Reviewed-by: Jens Bache-Wiig <jens.bache-wiig@nokia.com>
Reviewed-by: Casper van Donderen <casper.vandonderen@nokia.com>
2012-08-21 13:41:01 +02:00
Gabriel de Dietrich
806dda08d6 Moving .qdoc files under examples/widgets/doc
Updated those .qdoc files to refer to the new relative examples
emplacement. Images and snippets to be moved later.

Also grouped all widgets related examples under widgets.

Change-Id: Ib29696e2d8948524537f53e8dda88f9ee26a597f
Reviewed-by: J-P Nurmi <j-p.nurmi@nokia.com>
2012-08-20 12:20:55 +02:00
aavit
94ac17c2cc Clean up QScreen::grabWindow()
Handle 0 WId parameter as meaning "desktop window"/whole screen.
Also, re-add the default values for the grab area, both for
convenience and compatibility with QPixmap::grabWindow() in Qt4.
Update the screenshot example so it doesn't comlain about usage of
deprecated QPixmap::grabWindow().

Change-Id: I2ad229113ddb8ded0388f2ebc0e8c703c6657f1f
Reviewed-by: Gunnar Sletta <gunnar.sletta@nokia.com>
2012-08-18 10:55:47 +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