| Commit message (Collapse) | Author | Age | Files | Lines |
|
|
|
|
|
|
|
| |
Add missing \ to escape the \c correctly.
Pick-to: 6.8 6.8.0
Change-Id: If948b3911fa52ca02f5177147ccb21cab618604b
Reviewed-by: Ulf Hermann <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Use active voice where possible, use sentence-style-capitalization,
remove the section list and add the [category]-spelling to help SEO
find the help pages.
Add a new macro that adds the repetitive sentence about qmllint spelling
its categories with the []-brackets.
Also avoid having the same name for titles and sections, and rename
accordingly.
Also join some alternative "To fix this ..." ideas in the examples
together.
Also avoid calling read-only properties constant, as that might cause
some confusion.
Pick-to: 6.8 6.7
Fixes: QTBUG-127640
Change-Id: Id5c041a8e15c4af4d7fd24b9409a12caab177269
Reviewed-by: Ulf Hermann <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Fixes the following warnings:
(qdoc) warning: Can't link to 'qquickattachedpropertypropagator.html'
(qdoc) warning: Can't link to 'Type Of Parameter In Signal Cannot Be Used'
(qdoc) warning: Can't link to 'QQmlEngine Class#QML_ELEMENT'
(qdoc) warning: Can't link to 'qml-qtqml-component.html'
(qdoc) warning: Can't link to 'import paths'
(qdoc) warning: Can't link to 'qml-var.html'
(qdoc) warning: Can't link to 'Qt Quick Shapes'
(qdoc) warning: Can't link to 'Qt Svg'
(qdoc) warning: Can't link to 'Native Menus'
(qdoc) warning: Can't link to 'Popup Items'
(qdoc) warning: Can't link to 'Popup Windows'
(qdoc) warning: Can't link to 'Grid QML Type'
(qdoc) warning: Can't link to 'layer.smooth'
Pick-to: 6.8
Change-Id: Ia61b0568f481018850027f445446f64122abb5fd
Reviewed-by: Sami Shalayel <[email protected]>
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
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: I49dc5f4d576ef8e715f871bcae1420aaac80f639
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The warning from prefixed import type is slightly weird and buggy
for now, so exclude its unfinished documentations from the docs.
Tracking the enhancement of the warning via QTBUG-127294.
Task-number: QTBUG-127294
Task-number: QTBUG-118112
Change-Id: I3db99ed71ec7dde9be65457cc7f61f22aa5d564e
Reviewed-by: Leena Miettinen <[email protected]>
Reviewed-by: Fabian Kosmale <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
| |
Re-add them once QTBUG-118109 is done, as the warnings are currently
always disabled in qmllint.
Pick-to: 6.7 6.8
Task-number: QTBUG-118109
Task-number: QTBUG-118112
Change-Id: I9a6dd5678ae25a2f7cb2133c79948f070a11df47
Reviewed-by: Fabian Kosmale <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
| |
The compiler warnings are not mature enough to be documented, so exclude
them from the documentation for now so that they don't pop up in the
list of qmllint warnings.
Pick-to: 6.7 6.8
Task-number: QTBUG-118112
Change-Id: If030390bb8e3d6299f3a7de064d868c01608833f
Reviewed-by: Leena Miettinen <[email protected]>
Reviewed-by: Fabian Kosmale <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
| |
Make sure that documentation for Binding, Timer, Connections,
LoggingCategory shows up again.
This amends 4bbbb6a86f595
Pick-to: 6.8
Fixes: QTBUG-127072
Change-Id: I0d10e4e1f5a95a006e761d4888c3cd6d69c689de
Reviewed-by: Paul Olav Tvete <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
qtqml.qdocconf was referring to 'Qt QML' as the landing page, which
caused incorrect output for the navigation (breadcrumbs) and the
generated page <title>s.
Update the naming to Qt Qml/Qt Qml Core, and apply it to also C++
and QML module page titles.
Pick-to: 6.8 6.7
Fixes: QTBUG-126094
Change-Id: I822ddc080f37fae607296b2df0d14ca16ac0f8ab
Reviewed-by: Ulf Hermann <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
* 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 <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
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 <[email protected]>
|
|
|
|
|
|
|
|
|
| |
Pick-to: 6.5
Fixes: QTBUG-112613
Change-Id: I502cbbaf2218d6ac2c7267ff386dd4f5d1b57c04
Reviewed-by: Nicholas Bennett <[email protected]>
Reviewed-by: Leena Miettinen <[email protected]>
Reviewed-by: Fabian Kosmale <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
Fixes various warnings when qdoc fails to link to APIs in Network,
SVG, or OpenGL modules.
Pick-to: 6.5
Change-Id: I4b28ea746094e5d49d6129aa2914f744cda22474
Reviewed-by: Axel Spoerl <[email protected]>
Reviewed-by: Paul Wicking <[email protected]>
|
|
|
|
|
|
|
| |
Pick-to: 6.3
Fixes: QTBUG-98116
Change-Id: I3d0a2ede380fd60bbe9c4e2852c4da3b737180ec
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
| |
Make the regular expression capture also future uses of
\instantiates, and escape the '+' characters when matching
the string 'C++'.
Pick-to: 6.3
Task-number: QTBUG-98116
Change-Id: Ifecfff540aff28f5fe116240a064a74ea80d09bf
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
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 <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
This macro has been moved to qtbase and renamed to
\versionlessCMakeCommandsNote.
Pick-to: 6.2
Task-number: QTBUG-95796
Change-Id: I941ba1a7db7180802c24d4d2417141668f0d3805
Reviewed-by: Alexandru Croitor <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This provides the overall the structure for the QML docs, but only the
qt_add_qml_module() command is fully documented. Follow-up changes
will populate the skeleton pages added here.
Remove the inline docs for qt6_add_qml_module() which were previously
embedded directly in the CMake source. This prevents having to
maintain two sets of docs and keep them in sync.
Task-number: QTBUG-82598
Task-number: QTBUG-88763
Task-number: QTBUG-89274
Pick-to: 6.2
Change-Id: I2d6105fecf2b9e5ecfa798872b5f1ef1f830eba2
Reviewed-by: Fabian Kosmale <[email protected]>
Reviewed-by: Alexandru Croitor <[email protected]>
Reviewed-by: Andrei Golubev <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
This is a more complex example that is also not that visually appealing.
Change-Id: Ia5ebfa407c6bcbd3d701068384bfd660833a867c
Reviewed-by: Tuukka Turunen <[email protected]>
Reviewed-by: Ulf Hermann <[email protected]>
(cherry picked from commit 86b9ae4da1be2f797f6d6762d870555ee8c893de)
Reviewed-by: Qt Cherry-pick Bot <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
- Add missing dependency to qtquick3d
- Remove qtscript, qtquickdialog dependencies
- Use multiline formatting to have a clean git history of dependencies
Pick-to: 6.0 6.0.0
Change-Id: If79df67ef14cce4156cd24042725e56654da4444
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
| |
Task-number: QTBUG-80316
Change-Id: I584b699a1eec88117f343870bd2cd01075da64f7
Reviewed-by: Maurice Kalinowski <[email protected]>
|
|
|
|
|
|
| |
Task-number: QTBUG-73058
Change-Id: Ic27cfdf76b8f77c9834baaeaf449434bf5f28416
Reviewed-by: Leena Miettinen <[email protected]>
|
|
|
|
|
|
|
| |
Change-Id: I922a8f2cf777f4da28200f538bc03c60528b57f5
Reviewed-by: Mitch Curtis <[email protected]>
Reviewed-by: Simon Hausmann <[email protected]>
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
There were a lot of documentation warnings introduced by the
separation of QtQml.Models and QtQml.WorkerScript modules
from the QtQml documentation project into their own
sub-projects.
Fix the above, and also ensure that the experimental
Qt.labs.qmlmodels QML types are listed in the documentation,
and add them also on the QML module page for QtQml.Models.
A few warnings remain, they may be indicative of issues
not in the scope of this commit.
Fixes: QTBUG-79812
Change-Id: Idc25c976e4c96feab4aae893519d6c9245f57a64
Reviewed-by: Paul Wicking <[email protected]>
|
|
|
|
|
|
|
|
| |
These might not be complete yet, but they do fix the
qdoc errors.
Change-Id: I75b0f0f7709a371149a6f7c82adfff9fe88408ea
Reviewed-by: Paul Wicking <[email protected]>
|
|
|
|
|
|
| |
Task-number: QTBUG-74391
Change-Id: I8cd8371e820efbe90d486aef4a68e17c92fd93ea
Reviewed-by: Paul Wicking <[email protected]>
|
|
|
|
|
| |
Change-Id: I738b9da5335afb048d2eda2edf2be5095a91d7e5
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
|
|
|
| |
Latest changes moved to xmlpatterns:
e08f9393acc6417598f328d7f4b7b082c5d57afa
Change-Id: I7e3054a3f0f11833053746294e3b2b958047394d
Reviewed-by: Venugopal Shivashankar <[email protected]>
Reviewed-by: Frederik Gladhorn <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Update the list of highlighted examples for modules in qtdeclarative.
Currently highlighted examples/demos for Qt Quick are in relatively
good condition, so keep the highlighting for them.
Add highlighting for 'Writing QML Extensions with C++' tutorial in
Qt QML.
Task-number: QTBUG-60629
Task-number: QTBUG-60630
Change-Id: If7fe8705cf8614d5a811d88f44a0c00ecf3348f0
Reviewed-by: Nico Vertriest <[email protected]>
|
|
|
|
|
|
|
|
| |
Examples in binary packages now directly match the install path.
Change-Id: I8cbef85c8bef840d6ff87ac308e2e82a835adcc7
Task-number: QTBUG-52953
Reviewed-by: Antti Kokko <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
| |
The examplesinstallpath variable in .qdocconf files defines the path
under QT_INSTALL_EXAMPLES where examples are found.
To match the way examples are packaged in Qt 5.6, prefix each
install path with the repository name.
Task-number: QTBUG-48736
Change-Id: Ic081654ad3dfb87d3053772fabd5546c75070a7c
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
| |
Task-number: QTBUG-41996
Change-Id: Ica6e069c7753a2004a4a4c0e93a49d1f240569d3
Reviewed-by: Martin Smith <[email protected]>
|
|
|
|
|
|
|
|
|
| |
The QHP meta info. was trying to link to the Qt Quick
page, which failed. This should fix the issue.
Task-number: QTBUG-46163
Change-Id: Ib012f8f73b74a51b7a8d4e849070742e94d40973
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
| |
Task-number: QTBUG-43810
Change-Id: I154ffa83512435c3e455937a3f81931a45d9e368
Reviewed-by: Martin Smith <[email protected]>
|
|
|
|
|
|
|
|
| |
Added modules to depends stat. qtquick.qdocconf
Task-number:QTBUG-43810
Change-Id: If6010a382e2c9011b7599f25eb31ba9c9c3b3eb0
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
|
|
| |
-url inherited from the url variable set in qtbase/doc/global
Change-Id: I94a0da7aa98af1fdd6140168fe9feb27b11c0bdb
Reviewed-by: Leena Miettinen <[email protected]>
Reviewed-by: Jerome Pasion <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
The Declarative State Machine Framework extends Qt's State Machine
Framework (QSM) into QML to provide types for creating and executing
state graphs in QML. This gives you the power of deterministic state
machines, but declaratively and without having to write all of the
boilerplate code. It is an alternative to the existing QML State type,
intended for more complex models.
[ChangeLog][QtQML] The Declarative State Machine Framework extends Qt's
State Machine Framework (QSM) into QML. This gives you the power of
deterministic state machines, but declaratively.
Change-Id: I02390ba7f1baed50935364530925bd75087299cb
Reviewed-by: Sebastian Sauer <[email protected]>
Reviewed-by: BogDan Vatra <[email protected]>
Reviewed-by: Brett Stottlemyer <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
A recent change (46959875) in qdoc raised QML types from
subnodes to top-level nodes. This change modifies the
documentation configuration file(s) accordingly.
Change-Id: Ic457d20368979aa15b546dceaf84fa2fb2d31091
Reviewed-by: Jerome Pasion <[email protected]>
Reviewed-by: Martin Smith <[email protected]>
|
|
|
|
|
|
|
|
|
| |
-new name is Qt Quick Examples and Tutorials
-includes tutorials, not just examples or code samples.
Task-number: QTBUG-36838
Change-Id: I660770cac1cdd71cd3b34bad878b0e59a088924b
Reviewed-by: Leena Miettinen <[email protected]>
|
|
|
|
|
| |
Change-Id: I4c4577edde96978a986606bf30fbb925f871bd42
Reviewed-by: Topi Reiniö <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
Update the examples to use Qt's resource file system to
store the qml files in, enabling them to run unmodified
in any platform/build configuration.
Also,
- Chapter 6: Move the plugin code to a subproject
and create a C++ application to use the plugin
- Update documentation related to above chapter
- Add thumbnails for the examples so they will
appear in Qt Creators example list.
Task-number: QTBUG-35001
Change-Id: I29122af11bb11c7e5e17993438e5fc18c7f96f89
Reviewed-by: Jerome Pasion <[email protected]>
Reviewed-by: Alan Alpert <[email protected]>
Reviewed-by: Kai Koehne <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
In 5.2, the HTML output is in a flatter structure and when they are
hosted in qt-project.org/doc, the documentation will be found at
http://qt-project.org/doc/qt-$QT_VER
The url variable is used by projects outside of Qt 5 which need
to link to Qt 5 documentation, such as Qt Creator.
Task-number: QTBUG-34584
Change-Id: Ie23c3748fbe780fa00f98404238099809df5ef06
Reviewed-by: Topi Reiniö <[email protected]>
Reviewed-by: Leena Miettinen <[email protected]>
Reviewed-by: J-P Nurmi <[email protected]>
|
|
|
|
|
|
|
|
|
| |
-used by the navigation bar in the HTML output
Change-Id: If4689381fb01c0a6fe8adbd966ead1377942a101
Reviewed-by: Martin Smith <[email protected]>
Reviewed-by: Topi Reiniö <[email protected]>
Reviewed-by: Venugopal Shivashankar <[email protected]>
|
|
|
|
|
|
|
|
|
| |
Qt QML: added QML types page as a child in the list
Qt Quick Dialogs: "manual" as type taken out
Change-Id: I95d77b7582a0f5729801e1e6fb8f5f3242a0b760
Reviewed-by: Caroline Chao <[email protected]>
Reviewed-by: Martin Smith <[email protected]>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
-Took out members of QtQml.Models submodule from Qt QML and Qt Quick.
-Set up qdocconf files to include QtQml.Models to be part of Qt QML
doc build.
-Edited the sentences to make it clearer that list and model types
are in QtQml.Models.
-Placed the Visual* types back to QtQuick 2 module.
-This patch removes several collision pages.
Change-Id: I16e7045162af6852e5d6c3162b6f4cf97a42402b
Reviewed-by: Alan Alpert <[email protected]>
|
|
|
|
|
|
|
|
|
|
| |
The guide is more relevant to Qt, not just Qt QML and Qt Quick. It
would need to include information about the tools and other Qt modules
which provide QML types.
Change-Id: I0cab0db015022dd27f08811a88ea4a6c3c6e917d
Reviewed-by: Sze Howe Koh <[email protected]>
Reviewed-by: Geir Vattekar <[email protected]>
|
|\
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Conflicts:
examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc
examples/quick/accessibility/doc/src/accessibility.qdoc
examples/quick/animation/doc/src/animation.qdoc
examples/quick/canvas/doc/src/canvas.qdoc
examples/quick/draganddrop/doc/src/draganddrop.qdoc
examples/quick/imageelements/doc/src/imageelements.qdoc
examples/quick/keyinteraction/doc/src/keyinteraction.qdoc
examples/quick/localstorage/doc/src/localstorage.qdoc
examples/quick/mousearea/doc/src/mousearea.qdoc
examples/quick/particles/affectors/doc/src/affectors.qdoc
examples/quick/particles/customparticle/doc/src/customparticle.qdoc
examples/quick/particles/emitters/doc/src/emitters.qdoc
examples/quick/particles/imageparticle/doc/src/imageparticle.qdoc
examples/quick/particles/system/doc/src/system.qdoc
examples/quick/positioners/doc/src/positioners.qdoc
examples/quick/righttoleft/doc/src/righttoleft.qdoc
examples/quick/scenegraph/customgeometry/doc/src/customgeometry.qdoc
examples/quick/scenegraph/openglunderqml/doc/src/openglunderqml.qdoc
examples/quick/scenegraph/simplematerial/doc/src/simplematerial.qdoc
examples/quick/threading/doc/src/threading.qdoc
examples/quick/touchinteraction/doc/src/touchinteraction.qdoc
examples/quick/views/doc/src/views.qdoc
Change-Id: Idf7bb76c82acacf86b19a9f4633c3cbf4ae1a9a0
|
| |
| |
| |
| |
| |
| | |
Task-number: QTBUG-30233
Change-Id: Ic0a6d9112dbf8903d68f571e0ac853d89ff31ebe
Reviewed-by: Jerome Pasion <[email protected]>
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Make page titles follow the conventions at
http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation.
Make class/type list titles follow the "<Qt Module> C++ Classes" and
"<Qt Module> QML Types" formats.
Links are updated accordingly, along with broken links found during this
sweep. Some inline links also have their surrounding text modified, to
improve flow.
Change-Id: I0ed7788caa250085d7ea0080a77d8a2655debf39
Reviewed-by: Alan Alpert <[email protected]>
|
|\|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| | |
Conflicts:
examples/quick/textureprovider/etcprovider.h
src/plugins/qmltooling/qmldbg_ost/qmlostplugin.cpp
src/qml/doc/qtqml.qdocconf
src/quick/doc/qtquick.qdocconf
tests/auto/quick/qquickflickable/tst_qquickflickable.cpp
Change-Id: I5027b0ee024e00b9525bd45516b7f401ff7d4ae4
|