aboutsummaryrefslogtreecommitdiffstats
path: root/src/labs/platform/doc
Commit message (Collapse)AuthorAgeFilesLines
* Deprecate the dialogs in Qt.labs.platformOliver Eftevaag2024-12-051-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | With recent improvements made to our dialogs in QtQuick.Dialogs, it would make sense to deprecate our dialogs in labs platform. As I've understood it, this has been the plan all along. Our documentation should also become less confusing as a result. In Qt 6.8, we made all dialogs in QtQuick.Dialogs use top-level popup windows (18c4bf827dabea735435887f84ad1bea4136b1ea), which improves the usability on desktop systems. This was the advantage that the Qt.labs.platform dialogs had over QtQuick.Dialogs, due to the Qt.labs.platform dialogs using our standard dialogs in QtWidgets as fallback, which has always been top-level windows. In Qt 6.9, we're also adding a sidebar to the QtQuick.Dialogs file and font dialogs. [ChangeLog][QtLabsPlatform] FileDialog, FontDialog, FolderDialog, MessageDialog and ColorDialog are now deprecated. Use QtQuick.Dialogs instead. Task-number: QTBUG-130864 Change-Id: I38a5bd66d50a12973607777b4e40f2ae85c98b5d Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
* Docs: Organize topics in the qtdeclarative/Qt Labs Platform projectAlexei Cazacov2024-07-251-1/+5
| | | | | | | | | | This commit organizes the articles, so they: - have a reasonable tree structure - can be navigated through the topic tree in the Qt Creator help viewer Task-number: QTBUG-126648 Change-Id: Ie7c7a4a0f804056c0051a25852b7c5e90b6e3526 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Correct doc snippet licenseLucie Gérard2024-03-221-1/+1
| | | | | | | | | | | | | | All file under doc/snippet should be license as Documentation snippets and according to QUIP-18 [1] thi is LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 6.7.0 Task-number: QTBUG-121787 Change-Id: Iee9bc9b8c2a81695c5825a36768b36db2726bd35 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Fix undocumented parameters and broken linksTopi Reinio2023-09-151-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * src/qml/jsapi/qjsengine.cpp: (qdoc) warning: Can't link to 'qvariant_cast()' * src/quick/items/qquickrhiitem.cpp: (qdoc) warning: Undocumented parameter 'item' in QQuickRhiItemRenderer::synchronize() (qdoc) warning: Can't link to 'msaaColorBuffer()' (qdoc) warning: Can't link to 'resolveTexture()' * src/quick/scenegraph/util/qsgtextnode.cpp: (qdoc) warning: No such enum item 'Text.NativeRendering' in QSGTextNode::RenderType (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setColor() (qdoc) warning: Undocumented parameter 'color' in QSGTextNode::setSelectionColor() (qdoc) warning: Undocumented parameter 'viewport' in QSGTextNode::setViewport() * examples/quick/rendercontrol/rendercontrol_rhi/doc/src/ rendercontrol_rhi.qdoc: (qdoc) warning: Can't link to 'QWidget-based' (qdoc) warning: Can't link to 'QAnimationDriver' Mark all documentation modules in qtdeclarative as free of warnings. Change-Id: I97cc059701c351b53cdeeb5fc2feff923c5a76a8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove warninglimit .qdocconf variableTopi Reinio2023-06-271-3/+0
| | | | | | | | | | | | | | | | The most common limit for the maximum number of allowed documentation warnings is zero. As all Qt module docs include() a common configuration from qtbase, it's better to control the base warninglimit from a central location in qtbase/doc/global. This allows for a temporary increase of the limit across all modules as needed - for example, when updating the QDoc binary that the CI provisions to a version that introduces new types of documentation warnings. Task-number: QTBUG-113326 Change-Id: I7e5be717195049a6ce1d0a10ccbb1daeb175d714 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: remove "2" from Qt Quick Controls filesMitch Curtis2022-12-011-1/+1
| | | | | | | | | | | | | Work on this was already started for the documentation in 1abdfe5d5a052f2298b7bf657513dfa7e0c66a56. The CMake target (docs_QuickControls2) probably can't be renamed until we rename the library, which won't happen until Qt 7. Task-number: QTBUG-95413 Change-Id: Ied20805a91286436606577c3de39671a447f27dd Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Doc: unify "Dynamically Generating Menu Items" across modulesMitch Curtis2022-10-212-0/+38
| | | | | | | | | | | | | | Both Qt Quick Controls and Qt Labs Platform can use the exact same snippet for this, so use the same approach in both modules. I would try to reuse the code (and documentation), but I'm not sure if the linking to the types contained within would work, nor if there would be conflicts, so to err on the side of caution, give each module its own copies. Task-number: QTBUG-64554 Change-Id: Id1cac733ad3eda12074234f882eeae289caa438a Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Deprecate Qt.labs.platform.StandardPathsShawn Rutledge2022-08-291-1/+1
| | | | | | | | | | It's been available in the QtCore module since 6.2. Pick-to: 6.4 Task-number: QTBUG-92806 Change-Id: I4da346823bd29f73c039e13aabd31f2274049974 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-113-78/+6
| | | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. Files that have to be modified by hand are modified. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I63563bbeb6f60f89d2c99660400dca7fab78a294 Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Enable zero warning limit for documentationVenugopal Shivashankar2022-01-141-0/+3
| | | | | | | Pick-to: 6.3 Fixes: QTBUG-98116 Change-Id: I3d0a2ede380fd60bbe9c4e2852c4da3b737180ec Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Drop version no. against the \qmlmoduleVenugopal Shivashankar2021-12-021-1/+1
| | | | | | | | | | | | Since Qt 6.x, it is not mandatory to have version no. against the module import statements. Pick-to: 6.2 6.2.2 Task-number: QTBUG-98481 Change-Id: Ia3d35f2dc198d3e9c02d15784ca07c9bbb9526ce Reviewed-by: Richard Moe Gustavsen <richard.gustavsen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Shawn Rutledge <shawn.rutledge@qt.io>
* Doc: Fix documentation warnings in qtdeclarativeTopi Reinio2021-09-031-2/+1
| | | | | | | | | | | | | | | | | | * QtLabsPlatform has its own documentation project, but its source directory was pulled into QtQuick docs, causing duplicate generation and warnings. * Fix \snippet paths for files that were renamed/moved around. * Clean up .qdocconf files, use the {,} syntax to set identical values for multiple variables. * Fix incorrect \sa link. Pick-to: 6.2 Fixes: QTBUG-96125 Change-Id: I4c83787ac23a5b40019c74d46ee87c968a8d4907 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-311-4/+0
| | | | | | | | | | customFilters defined in .qdocconf are not supported anymore by Qt Assistant since Qt 5.13. Therefore remove them from all .qdocconf files, also to avoid cargo-culting them to new help modules. Task-number: QTBUG-95987 Change-Id: Id17e9c73093aea87d66d13454cbfe9172916fb37 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Update to latest qml CMake APICraig Scott2021-06-0516-0/+238
The new qml CMake API places a closer relationship between the backing target and the plugin target. Both are typically created together and they share a lot of common details. Instead of creating them in different parts of the source tree, they are now specified together. The src/imports area has effectively been absorbed into the other corresponding subdirectories below src with this change. Task-number: QTBUG-91621 Change-Id: I9bd32e9eb78c198ccc9db04e2829303cac323502 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>