summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix copy-paste error in QOpenGLTexture::Target docsLeena Miettinen2020-01-281-1/+6
| | | | | | | | Add a link to https://www.khronos.org/opengl/wiki/Array_Texture. Fixes: QTBUG-49802 Change-Id: Ic740dd758c41a8f3e471a503bd2d02f6d3096f50 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Bump copyright yearJani Heikkinen2020-01-094-4/+4
| | | | | | Change-Id: I9468ef21a2cf03cf07c38f012a2aa9bae6d02a03 Reviewed-by: Johanna Äijälä <johanna.aijala@qt.io> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
* Doc: Move the common documentation to a qdocincVenugopal Shivashankar2019-11-181-0/+129
| | | | | | | | | | The member functions of QStandardPath and Qt.labs.platform.StandardPath behave the same, so it's ideal to maintain their documentation in one place. Task-number: QTBUG-79827 Change-Id: I349dbb85cd9b6a3bedac329c0707fc07057cd64b Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Prevent QDoc from auto-linking certain wordsv5.14.0-beta2Topi Reinio2019-10-191-0/+6
| | | | | | | | | | | | | | | | | | 'macOS' appears in the documentation frequently, and because it resembles a variable/property name, QDoc links each occurrence of it. 'WebChannel' appears as part of a module name, but it's also a QML type - auto-linking each word to QML documentation is confusing. Likewise, there's no need to link 'OpenGL' each time. Explicit links such as \l [QML] WebChannel continue to work. Task-number: QTBUG-79135 Change-Id: I76cc84b0076255e260aa88c244102702a48f35a6 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'origin/5.13' into 5.14Friedemann Kleint2019-09-092-3/+49
|\ | | | | | | | | | | | | Conflicts: tests/auto/gui/text/qtextlayout/tst_qtextlayout.cpp Change-Id: Idd3ca5cb9a2b95a4c3513b2a4c8966e6f56193f1
| * Doc: Add external links to new topics in Qt Creator ManualLeena Miettinen2019-09-051-2/+46
| | | | | | | | | | | | | | These topics were added to Qt Creator Manual 4.9 and 4.10. Change-Id: I2e9bf355eb78b5e9877d0ca0bc41de00ed2b4333 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
| * Doc: Add doc/config directory to installed docsTopi Reinio2019-08-131-1/+3
| | | | | | | | | | | | | | | | | | This is needed to copy the .qdocconf files from that directory to QT_INSTALL_DOCS. Task-number: QTBUG-74391 Change-Id: Ia73d5c38c3c9588820401e8098b01f09e63292e4 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* | Remove dead code from Qt 4 timesTor Arne Vestbø2019-08-201-0/+0
| | | | | | | | | | | | | | | | | | | | The benefit of keeping this code around was to inspire or inform changes in the areas to take into account possibly missing features in Qt 5, but at this point that benefit is questionable. We can always use the history to learn about missing pieces if needed. Change-Id: I87a02dc451e9027be9b97554427bf8a1c6b2c025 Reviewed-by: Tor Arne Vestbø <tor.arne.vestbo@qt.io>
* | Introduce Q_NAMESPACE_EXPORTGiuseppe D'Angelo2019-06-281-0/+1
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | A recurring problem with the Q_NAMESPACE macro is that it declares an object (staticMetaObject) in the surrounding namespace. That object lacks any export/import qualification to make it usable with shared libraries. Introduce therefore another macro to work around this issue, allowing the user to prefix the object with an exporting macro, f.i. like this: Q_NAMESPACE_EXPORT(Q_CORE_EXPORT) The old macro can simply then be rewritten in terms of this new one, supplying an empty export macro. Note that NOT passing an argument to a macro expecting one is well defined behavior in C99 -- the macro will expand an empty token. Of course, MSVC doesn't like this and emits warnings. As a workaround, use a variadic macro. [ChangeLog][QtCore] Added the new Q_NAMESPACE_EXPORT macro. It can be used just like Q_NAMESPACE to add meta-object information to a namespace; however it also supports exporting of such information from shared libraries. [ChangeLog][Potentially Source-Incompatible Changes] Prefixing Q_NAMESPACE with an export macro may no longer work. Use the new Q_NAMESPACE_EXPORT macro for that use case. Fixes: QTBUG-68014 Change-Id: Ib044a555ace1f77ae8e0244d824ec473550f3d8e Reviewed-by: Edward Welbourne <edward.welbourne@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: BogDan Vatra <bogdan@kdab.com>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-05-0338-0/+38
| | | | | | | | | | | | | | Instead of generating .html page for each file in an example project, generate links to code.qt.io, under the correct path and branch, where the user can browse the example source. Store all URLs under QT_INSTALL_DOCS/config where other qt5 submodules can access them. The repository name appears in the URL, so we cannot define a single URL for all modules. Task-number: QTBUG-74391 Change-Id: I63d4d6d2c352877797b1ee8e057d48c0cd789bff Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Merge remote-tracking branch 'origin/5.12' into 5.13Friedemann Kleint2019-05-271-0/+10
|\ | | | | | | Change-Id: Iaf6bd52972b562b9c91d9e93a988d26b0eb9d3b4
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-05-093-1/+56
|\| | | | | | | | | | | | | | | | | | | | | Conflicts: src/corelib/tools/qlocale_data_p.h (Regenerated by running the scripts in util/local_database/) src/gui/opengl/qopengltextureuploader.cpp Done-With: Edward Welbourne <edward.welbourne@qt.io> Done-With: Allan Sandfeld Jensen <allan.jensen@qt.io> Change-Id: I12df7f066ed0a25eb109f61c4b8d8dea63b683e2
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-04-261-6/+5
|\| | | | | | | Change-Id: I6ecf7074eda57ef4954fb3fdc7a6d1e8cd229340
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into 5.13Qt Forward Merge Bot2019-03-111-19/+0
|\| | | | | | | Change-Id: Iecdf00ca61d819bde532daa42f093860ec4a499e
| * 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' into devLiang Qi2019-01-264-4/+4
|\| | | | | | | | | | | | | | | Conflicts: src/android/templates/AndroidManifest.xml tests/auto/widgets/styles/qstylesheetstyle/tst_qstylesheetstyle.cpp Change-Id: I4c9679e3a8ebba118fbf4772301ff8fde60455b9
| * 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>
* | | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2019-01-211-0/+1
|\| | | | | | | | | | | | | | | | | | | | Conflicts: .qmake.conf Change-Id: Ibfcb30053f3aacb8ec2ec480e146538c9bf440ea
| * | 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>
* | Merge remote-tracking branch 'origin/5.12' into devLiang Qi2018-10-253-815/+797
|\| | | | | | | | | | | | | | | | | Conflicts: src/corelib/animation/qpropertyanimation.cpp src/gui/image/qicon.cpp tests/auto/widgets/itemviews/qtableview/tst_qtableview.cpp Change-Id: I3698172b7b44ebb487cb38f50fd2c4a9f8a35b21
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2018-09-291-0/+5
|\| | | | | | | Change-Id: I6083c3e61b7dbe188f83676f7e7bb268e5ccf2f3
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2018-09-2511-492/+0
|\| | | | | | | Change-Id: I65e4457a218f333161e9e72735b62fc821475f45
| * 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>
* | Merge remote-tracking branch 'origin/5.12' into devQt Forward Merge Bot2018-09-162-80/+0
|\| | | | | | | Change-Id: Ic3ffc44d61448a44353c004b9f6703786cc1b213
| * 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>
* | Doc: Add a define for online and offline documentation templatesTopi Reinio2018-09-062-0/+4
|/ | | | | | | | | | | | | | | | | The browser backend for offline documentation has fewer capabilities when it comes to CSS and JavaScript support. These defines allow us to use \if conditionals when needed: /*! \if defined(onlinedocs) <Content that is rendered in online documentation> \else <Fallback for offline docs> \endif */ Change-Id: Ia51acb937754f22f2ece2836b4fb1470bf9ade90 Reviewed-by: Martin Smith <martin.smith@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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-19 19:59:31 +0000