summaryrefslogtreecommitdiffstats
path: root/src/datavisualization/doc
Commit message (Collapse)AuthorAgeFilesLines
* Correct license for snippets and examples filesLucie Gérard2024-03-157-7/+7
| | | | | | | | | | | | According to QUIP-18 [1], all examples and snippets file should be LicenseRef-Qt-Commercial OR BSD-3-Clause [1]: https://contribute.qt-project.org/quips/18 Pick-to: 6.7 Task-number: QTBUG-121787 Change-Id: Iad147b8191e42a18137378f315bd18182784acaa Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: List of all Qt overviews which are now termed as explanationJaishree Vyas2023-07-191-0/+1
| | | | | | | | | | | | | The autogenerated list of overviews was adding the \group command which included all the groups instead of overviews. The idea here is to categorize the overviews later on once we have the list of all overviews. Task-number: QTBUG-114762 Pick-to: 6.5 6.6 Change-Id: I3cf53886be277abc86b5ec54d399cd6933fbe882 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Doc: Remove \ingroup all-examples command from the docsJaishree Vyas2023-07-121-1/+0
| | | | | | | Fixes: QTBUG-115044 Pick-to: 6.5 6.6 Change-Id: I83314f3b7955e1ef9c857bcc96c07f6f90b2f875 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Document the lack of support for transparencyTomi Korpipaa2023-06-052-0/+4
| | | | | | | | Pick-to: 6.5 6.6 Fixes: QTBUG-114178 Change-Id: I4316135b4c96cafa28cf813621cff9803e6e2790 Reviewed-by: Sami Varanka <sami.varanka@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Doc: Remove 'Graphics' category from examplesTopi Reinio2023-05-091-2/+0
| | | | | | | | | | In Qt 6.6, the Qt Graphs module will replace Qt Data Visualization. Stop promoting examples from this module, as Qt Graphs provides a similar set. Change-Id: If0d50df6bb0cd1046a3c877815639902edd1ba8b Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix 2 documentation bugsTomi Korpipaa2023-03-032-2/+2
| | | | | | | Pick-to: 6.5.0 Change-Id: I20181ab31953bcfec25ccfe87de079296b534425 Reviewed-by: Dilek Akcay <dilek.akcay@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Combine 2 more widget examples into graph galleryTomi Korpipaa2023-02-271-5/+5
| | | | | | | | | | | Combine the 2 scatter graph examples into graph gallery example. Note: surface examples will be combined into graph gallery in other commits, to avoid making one gigantic commit. Pick-to: 6.5 Task-number: QTBUG-110698 Change-Id: I8c50d07a31a8b1ee84596f4e216e629d88c7846a Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Combine 3 examples into one qmlsurfacegalleryTomi Korpipaa2023-02-102-8/+8
| | | | | | | | | | | Combine qmlsurface, qml3doscilloscope, and qmlspectrogram into one surface graph gallery example. Pick-to: 6.5 Fixes: QTBUG-110700 Change-Id: Ic8319884a61a12c5d65c68314c958a86d62a65b1 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Fix example naming and categoriesTomi Korpipaa2023-01-277-20/+20
| | | | | | | | | | Remove 2 more irrelevant examples Pick-to: 6.5 Fixes: QTBUG-110463 Change-Id: I9597f311d36fb79db45f6f64fb97bc5376372980 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Normalize page namesKai Köhne2022-11-021-3/+3
| | | | | | | | | | | | | | qdoc does enforce lowercase file names for .html pages, and also replaces underscore with a dash. Make sure that the original \page name already is normalized, so that it's easier to search. This was done by find . -name "*.qdoc" -exec perl -p -i -E "s/\\\page (.*)/\\\page \L\1/ && s/_/-/g" {} ; Pick-to: 6.4 Change-Id: I3fc5896a62af744d5fd9ac4956ba4b3a2594df0a Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Specify module headerKai Köhne2022-07-221-0/+1
| | | | | | | | | | Fixes (qdoc) Could not find the module header in include paths for module "QtDataVis3D" Pick-to: 6.4 Change-Id: I6d79454dbacc06805cea986b5f0739febed6a085 Reviewed-by: Luca Di Sera <luca.disera@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-1316-430/+32
| | | | | | | | | | | Replace the current license disclaimer in files by a SPDX-License-Identifier. License files are organized under LICENSES directory. Pick-to: 6.4 Task-number: QTBUG-67283 Change-Id: I3b3112f5a36673b90fff0010f973d020886cf08d Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Show CMake, qmake information in C++ class documentationKai Köhne2022-03-231-0/+2
| | | | | | Pick-to: 5.15 6.2 6.3 Change-Id: I3f7c7150b9a3409fa17a7009b2e69142d17548bc Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Revise Qt Datavis module landing pageAndreas Eliasson2022-03-031-26/+23
| | | | | | | | | | This module landing page follows the style and structure from the Qt CoAP module landing page. Task-number: QTBUG-100369 Pick-to: 6.3 Change-Id: I7062888d0c5a13392c0e2b6f2970677b8a9269d0 Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Doc: Fix example manifest filesKai Köhne2021-11-011-26/+26
| | | | | | | | | Amends 793e48f42cd75 Fixes: QTBUG-97683 Pick-to: 6.2 Change-Id: Ib87660093e2dab98d6b61570064117c75d7345f4 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Add hasSeries method to Abstract3D graphSami Varanka2021-09-244-0/+13
| | | | | | | | | | | | | Added a hasSeries method to Abstract3Dgraph. The method can be used to check whether a series has already been added to the graph. In addition, modified cpp and qml autotests to test the added method. Fixes: QTBUG-96683 Change-Id: I91f70ca15b6c5fbaa7691cd17bbfc2ef460c3d37 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-09-031-3/+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: I3f07ddc1657abaa59e5c0b6756bf7833bbfd85cd Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add: Margin between series columns in Bars3DSami Varanka2021-08-241-0/+8
| | | | | | | | | | | | | | Added a new property to Bars3D. The property controls the margin between the columns of series. It can be used to show bars belonging to same column, but different series side by side. Also added autotest for qml and cpp. Fixes: QTBUG-69036 Change-Id: I3c353e9097a8be8cafc05f8f5120e4266baa4a5c Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Change name of help moduleKai Köhne2021-08-031-1/+1
| | | | | | | | | Make the name of the help project match the name of the installation directory. Pick-to: 6.2 Fixes: QTBUG-95270 Change-Id: I185f5d1c42dfd142cbf5d9104b342b559bd09a8e Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove references to multimedia and xmlpatternsLars Knoll2021-06-071-1/+1
| | | | | | | Those modules are not used anywhere inside this module. Change-Id: I21cafca4705172cfdaf4336cc4bfcc43d90306a7 Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>
* Fix direct rendering doesn't show anythingSami Varanka2021-06-041-15/+8
| | | | | | | | | | | | | | | | | | | | | | Rendering a graph directly to background didn't work in Qt 6 since it uses RHI and there is no way to not clear the color buffer before rendering. The graph uses direct OpenGL calls to render directly to background. Enabled direct rendering to qml3doscilloscope example. In addition, RenderDirectToBackground_NoClear got deprecated. When rendering directly to background, using non-transparent qml item as a background will hide the graph. This was already mentioned in the documentation but not clearly enough. Updated documentation for AbstractGraph3D. Pick-to: 6.1 Fixes: QTBUG-90665 Change-Id: I53081bac382ab89573359886e4f5c4b41be8e86d Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix documentation issuesTopi Reinio2021-04-271-7/+6
| | | | | | | | | | * Restore removed example snippet tags * Fix issues in the .qdocconf file Pick-to: 6.1 Task-number: QTBUG-91875 Change-Id: Iff7068204b5713fbf9f9f568834b55c5c282abba Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove obsolete namespace documentationVolker Hilsheimer2021-04-202-12/+4
| | | | | | | | | | | | | | That there is a 'using namespace QtDataVisualization' statement in the 'galaxy' manual tests suggests that there used to be one, but there isn't anymore. This documentation appears to have been for that long-gone namespace, so remove it to silence qdoc. Fix references to the now global qDefaultSurfaceFormat utility function. Pick-to: 6.1 Change-Id: Ide7689ee30af60f8c97649672f8a0f5ad455c35e Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Replace \default with \qmldefault for QML APIsVolker Hilsheimer2021-04-194-4/+4
| | | | | | Pick-to: 6.1 Change-Id: Idb633687f84c08f1b873a44af6fc9e1a64a4bee5 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Remove extra example from highlightsTomi Korpipaa2021-04-141-2/+1
| | | | | | | | Pick-to: 6.1.0 Pick-to: 6.1 Change-Id: Ib983262d4d90df3b976c91cbd2b6e9c652ae9932 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Add documentation for the RHI backend selectionTomi Korpipaa2021-03-041-0/+5
| | | | | | | | | Pick-to: 6.1 Fixes: QTBUG-90663 Change-Id: Ifc972c20e273e5ae060bc70d289027350428599f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Tuomo Pelkonen <tuomo.pelkonen@qt.io> Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Fix macOS build that has -Wunused-function as errorTomi Korpipaa2021-02-101-1/+1
| | | | | | | | | | Clang may interpret static inline function as unused, although it should not. Pragma it out for clang. Fixes: QTBUG-91053 Pick-to: 6.1 Change-Id: I8fd8bec5236752189deff8a2f6ceb62e572dca30 Reviewed-by: Antti Määttä <antti.maatta@qt.io>
* Remove custom namespaceTomi Korpipaa2021-01-287-12/+1
| | | | | | Fixes: QTBUG-90400 Change-Id: Ia2f1974a21112bad97724717d073d367c4413a7f Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io>
* Force OpenGL backend for RHITuomo Pelkonen2021-01-273-0/+3
| | | | | | | | Set QSG_RHI_BACKEND environment variable to "opengl" to force RHI to use OpenGL backend. Change-Id: Ie1fa0ffe466f97b1bbcc5281c49bbdf6e6d053c0 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Use QList instead of QVectorJarek Kobus2020-06-251-1/+1
| | | | | | | Task-number: QTBUG-84469 Change-Id: I4dc064b70adb054ca4add2dd662e7227255ff970 Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Lars Knoll <lars.knoll@qt.io>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: I8cefab01c450ad5b52ba57ba161ee9065e00a6b1 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Fix QML import versionTomi Korpipaa2019-03-142-2/+4
| | | | | | | Task-number: QTBUG-74032 Change-Id: I1fca2212a2013fe18388e5e1e20e75847ee6be8b Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Kai Koehne <kai.koehne@qt.io>
* Do show module license on all help pagesKai Koehne2018-09-271-0/+1
| | | | | | | | | | | | | | | | | | | Qt Data Visualization has a different main license than most other Qt modules, which is easy to miss. We do show the license on the module landing page and in the 'All modules' overview page, but if you directly open an example or a class page you can still miss this. This change adds the main license description to the header shared by all pages of the module; we (mis)use the buildversion variable for that, which was so far unused. Right now qdoc does not 'linkify' the entry. It could add a generic link to the landing page though, where the license is also described. Task-number: QTBUG-70354 Change-Id: Ic4917541a6480d1cb3879f87e6aac0093dd1f3b3 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Use FDL license for all .qdoc filesKai Koehne2018-05-309-99/+81
| | | | | Change-Id: I732a95d5adbd7579b05e8cb2b1afd586d5b5bc58 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Add license information to index pageKai Koehne2018-05-091-0/+6
| | | | | | Change-Id: I0c20e133621f4095df5fc7f53a3e1981d248a93f Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Fix wrong license headerv5.11.0-rc2v5.11.0-rc1v5.11.0-beta4v5.11.0-beta3v5.11.0Jani Heikkinen2018-03-281-10/+21
| | | | | | | | | Some old license header were used. replace it with proper one Task-number: QTBUG-67308 Change-Id: I6c501ab381c4ebb9f0b3466c303447edf3531915 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io> Reviewed-by: Simon Quigley <tsimonq2@ubuntu.com>
* Doc: Update the list of highlighted examplesTopi Reinio2017-11-091-1/+1
| | | | | | | | | Drop highlighting for 'Surface Example' in favor of 'Qt Quick 2 Surface Multiseries Example'. Task-number: QTBUG-60663 Change-Id: I7a8e3c501b7d5eaf500d3e0eca2eb41c17d182d5 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Update the highlighted examples listv5.10.0-beta2Venugopal Shivashankar2017-10-051-1/+2
| | | | | Change-Id: Ied7eec2b6646d079ca2838f1b69d6626017818df Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Highlight bars examplev5.9.0-rc2v5.9.0-rc1v5.9.0Miikka Heikkinen2017-05-171-0/+2
| | | | | Change-Id: Ic152a0ce98d1feefe81a585b0086fd971ebe62ed Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Doc: Add an overview of data visualizationLeena Miettinen2017-03-213-35/+279
| | | | | | | | | Move some information from the front page and the known issues to the overview. Add some information to the interacting with data topic. Change-Id: Ia63e1d46ec48861a144c51f0d8796809ea771ea4 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix QDoc error by using #ifndef Q_QDOC to omit unused functionLeena Miettinen2017-03-171-2/+2
| | | | | | | | Also fix the function signature in the qdoc file. Change-Id: If8a7cb83f94efb9a5a999c99fce722e4ffb96312 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Remove installation and build informationLeena Miettinen2017-03-032-118/+6
| | | | | | | | Qt Data Visualization is now a standard Qt module that can be installed and built as any other module. Change-Id: Idb7e05304e159c30614d728529261d3ec2ea6002 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix \brief and \return commands (Q3dSurface)Leena Miettinen2017-03-021-11/+11
| | | | | | | | Remove property getter docs, because they do not add any info, and move setter docs to separate entries. Change-Id: I78a0dab0ec9652b58b319f09dc5266e36d12e85a Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Add \brief commands for property docs (QAbstract3dGraph)Leena Miettinen2017-03-021-79/+90
| | | | | Change-Id: I076eafb31ab9710f59eb47287cf91882a56bb8e7 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix QDoc commands (Q3dBars)Leena Miettinen2017-02-271-16/+33
| | | | | Change-Id: I75cb18ad5ea6b7c88c940d52ccb82753fcc0c7c7 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Doc: Fix \brief and \return commands (Q3dScatter)Leena Miettinen2017-02-271-14/+18
| | | | | Change-Id: I45c048acffc57b56205b694dd4fcb4b89917b5a3 Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* Merge remote-tracking branch 'origin/5.7' into 5.8Liang Qi2016-11-081-10/+9
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: examples/datavisualization/bars/doc/src/bars.qdoc examples/datavisualization/custominput/doc/src/custominput.qdoc examples/datavisualization/customitems/doc/src/customitems.qdoc examples/datavisualization/draggableaxes/doc/src/draggableaxes.qdoc examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc examples/datavisualization/qmlaxisdrag/doc/src/qmlaxisdrag.qdoc examples/datavisualization/qmlaxisformatter/doc/src/qmlaxisformatter.qdoc examples/datavisualization/qmlcustominput/doc/src/qmlcustominput.qdoc examples/datavisualization/qmloscilloscope/doc/src/qmloscilloscope.qdoc examples/datavisualization/qmlscatter/doc/src/qmlscatter.qdoc examples/datavisualization/qmlspectrogram/doc/src/qmlspectrogram.qdoc examples/datavisualization/qmlsurface/doc/src/qmlsurface.qdoc examples/datavisualization/qmlsurfacelayers/doc/src/qmlsurfacelayers.qdoc examples/datavisualization/rotations/doc/src/rotations.qdoc examples/datavisualization/scatter/doc/src/scatter.qdoc examples/datavisualization/surface/doc/src/surface.qdoc examples/datavisualization/texturesurface/doc/src/texturesurface.qdoc examples/datavisualization/volumetric/doc/src/volumetric.qdoc src/datavisualization/doc/src/qtdatavisualization.qdoc Change-Id: Ic15e77b1fee0708a235bf21815f72b854981537a
| * Doc: Use capitalization in section titlesTopi Reinio2016-11-021-9/+9
| | | | | | | | | | Change-Id: I3ea9dde5f98813716d754d292af1f005d33ba98e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
| * Doc: Add a \brief command to the QtDataVisualization namespace docsLeena Miettinen2016-10-101-2/+1
| | | | | | | | | | | | | | | | ...to display them correctly in tables. Change-Id: I09c92ebbe684828e282b7675b584a971f0f72f4f Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
* | Doc: Add dependency to Qt Widgets to enable automatic linkingLeena Miettinen2016-11-041-1/+1
| | | | | | | | | | | | Change-Id: Idf59ce8f3c225cbcd5c314fc1c25d94696ac3436 Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Tomi Korpipää <tomi.korpipaa@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-25 11:14:46 +0000