summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Adjust offline style for the litehtml rendering engineTopi Reinio2020-04-032-20/+7
| | | | | | | | | | | | | | | | | | | | | | | | | Qt Creator now has the option to use the litehtml backend as a replacement for the QTextBrowser-based help viewer. Fix a few issues that the offline style has with the litehtml renderer: - Fall back to using an unordered list for the navigation bar. - Remove the background image for #buildversion and adjust font size. - Adjust the generated padding around code snippets. Keep the script that switches the offline-simple.css style to the full offline style (offline.css) for JavaScript-enabled browsers. The litehtml backend in Qt Creator will handle this switch internally. With these changes, the generated offline documentation looks acceptable when rendered with QTextBrowser, litehtml, or desktop web browsers. Fixes: QTBUG-82567 Change-Id: I86b179b1985b7ef54feddab30cb227b28021efe5 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> (cherry picked from commit 0b5a1100ff5ab4fb696e0efc9bc5e8f266cf40ae) Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Bump copyright yearJani Heikkinen2020-01-204-4/+4
| | | | | | | | Change-Id: I9468ef21a2cf03cf07c38f012a2aa9bae6d02a03 Reviewed-by: Johanna Äijälä <johanna.aijala@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> (cherry picked from commit 1e42c97cf055ac20352d20150e2786c14565ea2b) Reviewed-by: Akseli Salovaara <akseli.salovaara@qt.io>
* Qt Widgets: Document CMake macrosKai Koehne2019-05-161-0/+5
| | | | | | | Task-number: QTBUG-72159 Change-Id: Ib9fdf852583964cf07c4d26e0a6c74f0058e29f1 Reviewed-by: Kevin Funk <kevin.funk@kdab.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Qt Core: Document CMake macrosKai Koehne2019-05-161-0/+5
| | | | | | | | | | Document public macros in Qt5CoreMacros.cmake. This will replace the list in the current CMake Manual. Task-number: QTBUG-72159 Change-Id: I377412fe0c1d0a9b232162bbab88ac830d2cac80 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Document how to use CMake on Qt Core, Qt GUI's central pagesKai Koehne2019-05-073-1/+56
| | | | | | | | | | | | | | | Add documentation on how to use a module from CMake, alongside the existing documentation about qmake. Separate generic info from module-specific examples, to make it possible to use one include file in all modules. While at it, also remove the mentioning of the central include; it is not something we should actively advocate anymore. Instead, the documentation of every class gives the correct include to use. Task-number: QTBUG-73058 Change-Id: I6b3c0e5ea218dd9c06a491c8fb799a7fcf42dd92 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Update external links to CMake documentationKai Koehne2019-04-251-6/+5
| | | | | | | | | | | We don't support CMake version 2 anymore. Instead of just updating to a newer (but fixed) version let's link to the latest documentation. This might create a bigger risk that links get stale, but hopefully let people find always the latest information. Task-number: QTBUG-72159 Change-Id: I082de80cf9ee107b5d017ab8ad6369f2448b0e1b Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Remove background colors from simplified offline CSSTopi Reinio2019-03-101-19/+0
| | | | | | | | | | | | | The simplified style needs to work for both light and dark themes in Qt Creator's help system. Background and text colors are already applied according to the active theme, this commit removes the rest of the hardcoded element colors that do not look good with a dark theme. Task-number: QTBUG-49417 Task-number: QTBUG-69327 Change-Id: Ib5ebe2755e98ca120f0500ab82713a37ec7199bd Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Merge remote-tracking branch 'origin/5.12.1' into 5.12Qt Forward Merge Bot2019-01-234-4/+4
|\ | | | | | | Change-Id: Icebd151eae0cf9d400319a42573290d1a911ce26
| * Bump copyright year to 2019Kai Koehne2018-12-184-4/+4
| | | | | | | | | | | | | | | | Task-number: QTBUG-72635 Change-Id: Idc9bd97fe873b332d7ff72cb44a00334a472404f Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Documentation: Add \nullptr macro and use where applicableFriedemann Kleint2019-01-101-0/+1
|/ | | | | | | | | | | | | | | | Qt for Python users reading the documentation assume that int(0) can be passed for pointer parameters. Use the newly introduced \nullptr to disambiguate this. In a follow-up step, the \nullptr macro can be defined as None when generating the Qt for Python documentation. Task-number: PYSIDE-903 Change-Id: I3a45f87175a0668ab5f3f95f0aff409f7e3ef027 Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io> Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Update online navigation header to match http://doc.qt.io/Tor Arne Vestbø2018-10-171-51/+18
| | | | | | Change-Id: I8154abc8cf2bb5895a75c4e41ff06cb99e4fedc5 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Update online CSSTor Arne Vestbø2018-10-163-762/+775
| | | | | | | | Copied from the CSS served by http://doc.qt.io/ Change-Id: Id37447e0f6de4a08a2632df862ae36f73d284814 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* doc: Update online HTML header URLsTor Arne Vestbø2018-10-161-3/+5
| | | | | | Change-Id: I2109f1a3113a724bfb6bc5a03b4c7b2d67f7e48c Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add a macro that expands to the Qt version (Major.Minor)Topi Reinio2018-09-251-0/+1
| | | | | | | | | | Versioning of some QML modules follows the Qt major and minor version exactly. Add a documentation macro that expands to the short version string to help automate the QML plugin documentation. Task-number: QTBUG-67818 Change-Id: I45e7a2a1adfd6a82b828222e49b1d02b7c05897e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Add a macro that returns the minor versionTopi Reinio2018-09-251-0/+4
| | | | | | | | | | | | | | | | | Add a global QDoc macro \QtMinorVersion that expands into the minor version of Qt, or more specifically, the minor version contained in the QT_VER environment variable. The main use case for the new macro is to document the QML modules whose minor versions track the minor version of Qt: \qmlmodule QtQuick 2.\QtMinorVersion Task-number: QTBUG-67818 Change-Id: I2b4fcbb18de0f8f95718099309090017c237622f Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Remove outdated and unmaintained examplesPaul Wicking2018-09-1711-492/+0
| | | | | | | | | | These examples are outdated and unmaintained, and have not been included in the documentation for a long time. Removing the files to avoid further confusion. Task-number: QTBUG-59249 Change-Id: I3e4c535219cc6b40f3add5430c0967eba2c80eb9 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Move touch examples around so they get included in docsPaul Wicking2018-09-142-80/+0
| | | | | | Task-number: QTBUG-59249 Change-Id: I71f1d2e28f0cadbad1d6bcf117198018eaf8e012 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Merge remote-tracking branch 'origin/5.11' into devQt Forward Merge Bot2018-08-171-0/+0
|\ | | | | | | Change-Id: I8bb8227f9da982e7d5ebe5324fc27abd9ac0d4fc
| * Doc: Update out-of-date screenshots in example docsPaul Wicking2018-08-161-0/+0
| | | | | | | | | | | | Task-number: QTBUG-63248 Change-Id: I4cd47977ae020b43ca92b1781ac8b038e6ef851c Reviewed-by: Martin Smith <martin.smith@qt.io>
* | Merge remote-tracking branch 'origin/5.11' into devQt Forward Merge Bot2018-08-072-1/+1
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/corelib/doc/src/objectmodel/signalsandslots.qdoc src/plugins/platforms/cocoa/qcocoamenuloader.mm src/plugins/platforms/xcb/qxcbconnection.cpp src/plugins/platforms/xcb/qxcbconnection.h src/plugins/platforms/xcb/qxcbconnection_xi2.cpp src/plugins/platforms/xcb/qxcbwindow.cpp tests/auto/gui/image/qimage/tst_qimage.cpp Done-with: Gatis Paeglis <gatis.paeglis@qt.io> Change-Id: I9bd24ee9b00d4f26c8f344ce3970aa6e93935ff5
| * Doc: Update really old screenshot in Sliders ExamplePaul Wicking2018-08-031-0/+0
| | | | | | | | | | | | Task-number: QTBUG-63248 Change-Id: Id756d86539987562b9455881364928ccf7349fbf Reviewed-by: Martin Smith <martin.smith@qt.io>
| * Doc: Fix broken links after page renamePaul Wicking2018-07-311-1/+1
| | | | | | | | | | | | | | | | | | | | | | The title of the external page 'Creating a Mobile Application' in the Qt Creator docs has changed to include a space between 'Qt' and 'Creator'. This caused the filename to change, thus breaking the incoming links from the Qt for (iOS|Android) Examples pages. Task-number: QTBUG-69678 Change-Id: I7819a9e2b483bc760af5bb636841bccf0c6cb739 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* | Merge branch '5.11' into devEdward Welbourne2018-07-311-9/+41
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: qmake/library/qmakebuiltins.cpp src/plugins/platforms/windows/qwindowstabletsupport.h src/plugins/platforms/xcb/qxcbconnection.cpp src/plugins/platforms/xcb/qxcbconnection.h src/plugins/platforms/xcb/qxcbconnection_xi2.cpp src/plugins/platforms/xcb/qxcbwindow.cpp src/widgets/styles/qstylesheetstyle.cpp tests/auto/widgets/styles/qstylesheetstyle/tst_qstylesheetstyle.cpp Done-With: Gatis Paeglis <gatis.paeglis@qt.io> Change-Id: I000b0eb3cea2a5c7a99b95732bfdd41507cf916e
| * Doc: Update external links to Qt Creator ManualLeena Miettinen2018-07-201-9/+41
| | | | | | | | | | | | | | Reflects version 4.7. Change-Id: Ia41b5c1a7eb829ab3c6ec0d3bd9fe60dcbfed54d Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Add demo of the new QGradient presets to the gradients exampleEirik Aavitsland2018-07-241-0/+0
|/ | | | | | | | In the gradients example, allow the user to select and show QGradient's named presets. Change-Id: I40bc6cbe3a0316ce49d67d63511881b6f6112574 Reviewed-by: Simon Hausmann <simon.hausmann@qt.io>
* Correct the documented visibility of some Widget methodsPaul Colby2018-07-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | Specifically, commit e80a3b49c0aac237104e1696fc64b3a924c89ca1 introduced the use of some QT_VERSION_CHECK macros to distinguish some methods' visibility between Qt 5 and Qt 6, however the QDoc falsehoods variable (added sometime prior) was sensitive to whitespace, and did not correctly recognize those version checks. This resulted in some methods being incorrectly documented as public instead of protected, or vice versa. This change simply makes the QT_VERSION_CHECK in QDoc falsehoods allow for optional whitespace. Methods affected by this change (in documentation only): * QListWidget::dropEvent() * QTableWidget::items(), ::indexFromItem(), itemFromIndex() * QTreeWidget::items(), ::indexFromItem(), and itemFromIndex() Task-number: QTBUG-68005 Change-Id: Ibe3e780334a9a915989ed43b5cdda6915c9161ec Reviewed-by: Luca Beldi <v.ronin@yahoo.it> Reviewed-by: Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Add references to QDBusAbstractAdaptor implementation examplePaul Wicking2018-06-291-36/+0
| | | | | | | | | | | | Adding references where applicable, as removed by 023a818738d64da01ebecc5d4a26356055ba0021 when removing stale example. Add example run snippet to the example landing page. Remove stale example qdoc file that is superceded by current example. Task-number: QTBUG-69191 Change-Id: I62dc66edc86da5efb4c79fd124edb2fa619aeb6b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Update br tag in html footer for XHTML compliancePaul Wicking2018-06-221-2/+2
| | | | | | Task-number: QTBUG-68459 Change-Id: Ie7c4a4e6d49c49db5814ee9b0a36387bed74fd38 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Use index.html as the home page referenceTopi Reinio2018-06-051-1/+2
| | | | | | | | | | | QDoc links to the homepage in the navigation bar; use index.html for linking instead of "Qt $QT_VER" to prevent incorrect links to section titles that clash with that string. Task-number: QTBUG-62484 Change-Id: I53ced31b7ce35d69579a8c70cbc475e306fd3b18 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Update Fetchmore exampleNico Vertriest2018-05-281-0/+0
| | | | | | | | | | - minor edit - updated screenshot Task-number: QTBUG-60635 Change-Id: I988ad28723131127eee0a93671b0562d8f446139 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Update Find Files exampleNico Vertriest2018-04-091-0/+0
| | | | | | | | | | - review text - update screenshot Task-number: QTBUG-60635 Change-Id: I596ce0e08be9ed9aea7834eeda1c3c2c19c28d7a Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Update Event Transitions ExampleNico Vertriest2018-04-091-0/+0
| | | | | | | | | | - added screenshot - some modifications to the text Task-number QTBUG-60635 Change-Id: I57b269f93cdba696b424b5ba008d0f46ac612cda Reviewed-by: Martin Smith <martin.smith@qt.io>
* Doc: Increment copyright year in global doc templatesLeena Miettinen2018-04-044-4/+4
| | | | | | | Change-Id: I687ea95c0985c361ffb75ea3c162615b0abbb7f7 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Complete Dynamic Layouts ExampleNico Vertriest2018-03-141-0/+0
| | | | | | | | | | | - add doc to code - replace old signal/slot syntax - more up-to-date screenshot Task-number: QTBUG-60635 Change-Id: Iec3d2c3d0d8b9c07ccd4446d74d5eca2d88e7e08 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: complete Dir View ExampleNico Vertriest2018-03-131-0/+0
| | | | | | | | - add updated screenshot - add basic doc to example code Change-Id: Iad616b285ee1470571adc38b868fcf8a0ed64840 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: complete Border Layout ExampleNico Vertriest2018-02-191-0/+0
| | | | | | Task-number: QTBUG-60635 Change-Id: Icc605e5bad96aaad0233d4b05ab1ed46972bd725 Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
* Merge remote-tracking branch 'origin/5.9' into 5.11Liang Qi2018-02-141-0/+1
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf src/corelib/animation/qvariantanimation.cpp src/corelib/global/qglobal.cpp src/corelib/global/qlogging.cpp src/corelib/io/qprocess_win.cpp src/corelib/json/qjsonarray.cpp src/corelib/tools/qsimd_p.h src/corelib/tools/qtimezoneprivate_p.h src/corelib/xml/qxmlstream_p.h src/gui/kernel/qsimpledrag.cpp src/gui/kernel/qsimpledrag_p.h src/plugins/generic/generic.pro src/plugins/platforms/cocoa/qcocoamenu.mm src/widgets/styles/qmacstyle_mac.mm tests/auto/concurrent/qtconcurrentmap/BLACKLIST tests/auto/corelib/io/qfileinfo/tst_qfileinfo.cpp tests/auto/corelib/tools/qdatetime/tst_qdatetime.cpp tests/auto/gui/kernel/qwindow/BLACKLIST tests/auto/widgets/dialogs/qmessagebox/BLACKLIST Change-Id: I508d686cf20f7f8cc6a7119b9bc7c3bbb505c58e
| * Doc: Mention exact Qt version the third party attributions apply toKai Koehne2018-01-191-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We do add, remove or update third party code in minor releases, sometimes even in patch level releases. However, the documentation is supposed to be valid for all existing Qt 5 versions, but doing this for attributions would require infrastructure we don't have. Therefore rather make it explicit which Qt version the attributions apply to. Also mention since when Qt is available under LGPLv3 (starting with Qt 5.4). Task-number: QTBUG-65665 Change-Id: I328b5bf0c143f78ea61aad51f0644c3cbb6dee49 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | qdoc: Remove __cplusplus from the defines listMartin Smith2018-02-031-3/+1
| | | | | | | | | | | | | | | | __cplusplus was removed from the list of defines passed to qdoc because it should not be there for clang-qdoc. Change-Id: I32802e68d915f7a5b717f16ba26a1cd57d7ff645 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: revamp Animated Tiles exampleNico Vertriest2018-01-161-0/+0
| | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: Iceb53e7c0df88bb51589a1cc86e905dbc60a856e Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | Doc: update screenshot Character MapNico Vertriest2018-01-031-0/+0
| | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: I15a2458703f69920c96f9478cf46a9eb0bfcca5e Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: complete Draggable Text exampleNico Vertriest2017-12-191-0/+0
| | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: Ib901c677ad78a663c3f3e0dd689b8d65be10be83 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Doc: complete Easing Curve ExampleNico Vertriest2017-12-181-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | - updated logo - updated screenshot - add link to easing.qdoc Task-number: QTBUG-60635 Change-Id: I9389dfbbe66cfa5f4e8641bee2f8fd63f5c95f99 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* | Merge remote-tracking branch 'origin/5.10.0' into 5.10Liang Qi2017-12-081-20/+0
|\ \ | | | | | | | | | Change-Id: I6dcf85067ec226136c207ea69ca9d66736c84db5
| * | Doc: Remove the default list of highlighted examplesTopi Reinio2017-11-131-20/+0
| | | | | | | | | | | | | | | | | | | | | Each module now maintain the list of examples to highlight separately. Change-Id: Ib9bca8d945bb3e81d4176cbbebcb89b1309dc0d4 Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* | | Doc: Minor corrections custom sort filter exampleNico Vertriest2017-11-291-0/+0
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: I17a69f85663eaa92e92b4e97385c21a729405e1f Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | | Doc: drop Application Chooser ExampleNico Vertriest2017-11-201-0/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | There are plenty of other examples showing how to use QStateMachine Task-number: QTBUG-60635 Change-Id: I82300b2a0f4e7733f08579a2aa9b548cb7d87efa Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
* | | Doc: Add screenshot to Validators exampleNico Vertriest2017-11-201-0/+0
| | | | | | | | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: Ie68e611b57900847a00587fdf8558be4be38f23d Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* | | Doc: drop Lighting Effect ExampleNico Vertriest2017-11-201-0/+0
|/ / | | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: If455a778ff6ebd53d8110b3dc25d8b9e27255bac Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io> Reviewed-by: Nico Vertriest <nico.vertriest@qt.io>
* | Doc: improve screenshots Application ExampleNico Vertriest2017-10-182-0/+0
| | | | | | | | | | | | Task-number: QTBUG-60635 Change-Id: I963ecbf0b386e9f5d41b4c15e2af883cf21d3c83 Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-01 16:16:19 +0000