summaryrefslogtreecommitdiffstats
path: root/src/interfaceframework/doc
Commit message (Collapse)AuthorAgeFilesLines
* Actualize Jinja documentation referencesZoltan Gera7 days2-5/+5
| | | | | | Pick-to: 6.11 Change-Id: I887594e58af5698276a4d1fd1ac11a8232d86c3a Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Add deprecation handling to JinjaZoltan Gera7 days2-2/+16
| | | | | | | | | | | | | | | Two new global functions are added to Jinja which can deprecate both templates and filters alike. The deprecation logic is based on the newest macros in C++ which handle both deprecation version and the version for code removal. In case of removal, an error fails the build. CMake configuration variables are also introduced which can set warning and error version boundaries respectively. [ChangeLog][ifcodegen] Introduced deprecation primitives for templates. Pick-to: 6.11 Change-Id: I0c4e56f84f674a0e6d6bb90968687e31b6e250a2 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Fix references to Jinja sourcesZoltan Gera7 days1-3/+3
| | | | | | | | | | Include and import references to Jinja sources and build system references to template files are fixed to use the changed extensions. Task-number: QTBUG-140720 Pick-to: 6.11 Change-Id: I427264a45fc3eca5aaea92e7a2cac19cce44b5b7 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* doc: Update the "What's New" Page with 6.10 changesDominik Holland2025-07-251-0/+9
| | | | | | Pick-to: 6.10 Change-Id: I40e76d4c6d830740cf2e6d8d6272c5e2f12a96f3 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Update the "What's New" Page with 6.9 changesDominik Holland2025-07-251-0/+7
| | | | | | Pick-to: 6.10 6.9 Change-Id: Icac8db87f92f7a67b2a377ea6caba3ba19bcae4c Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Doc: The documentation and the snippet seem to be contradictingDheerendra Purohit2025-03-271-3/+3
| | | | | | | | | | | | Add 'common.' prefix to Station type in Tuner interface Changed Station to common.Station everywhere This makes it clear that Station comes from the common module Fixes: QTBUG-134742 Pick-to: 6.9 6.8 6.5 Change-Id: I4f6071b71437e71fa0e6eb080ea678877c7f210a Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Update license checkLucie Gérard2025-03-203-2/+2
| | | | | | | | | | | | | | | | The module is now: - checked against quip18 [1] rules (licenseRule.json) - reuse compliant (REUSE.toml) - ready for source SBOM check [1] https://contribute.qt-project.org/quips/18 [ChangeLog][Third-Party Code] Rename license file with LICENSE. prefix. This way the file is ignored by the reuse tool. Task-number: QTBUG-131434 Pick-to: 6.8 6.9 Change-Id: Iaa52f0125719f5172f2e7522df816fcd3ced4928 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Enhance defaultServerMode with Android option and update annotationShveta Mittal2024-12-041-13/+13
| | | | | | | | | Added 'android' as a valid option for defaultServerMode, expanding beyond the previous 'gui' and 'headless' options. Moved defaultServerMode under the 'config' annotation for better organization, previously under 'config_simulator'. Task-number: QTBUG-130660 Change-Id: Ib7b730badbe47721c0a826c65ef4fb5832fc5ea0 Reviewed-by: Dominik Holland <dominik.holland@qt.io> Reviewed-by: Zoltan Gera <zoltan.gera@qt.io>
* Add flag for capturing target platform in generatorShveta Mittal2024-11-221-0/+5
| | | | | | | | This commit introduces a new flag to the generator to capture the target platform. This information will be passed from CMake to the Jinja templates, allowing for dynamic decision-making within the templates based on the specified target platform. Task-number: QTBUG-130661 Change-Id: I95fd6e075671b961c413c79a6342b538a96dd0f4 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Docs: fix incorrect annotation for config_simulator.defaultServerModeShveta Mittal2024-10-161-1/+1
| | | | | | | | | | The documentation incorrectly specified the annotation as 'defaultApplicationMode' instead of 'defaultServerMode' for config_simulator.defaultServerMode. This commit corrects the annotation to reflect the proper name, ensuring consistency with the intended configuration. Task-number: QTBUG-130082 Pick-to: 6.8 6.5 Change-Id: I057f4daec569f99a7bcdc897b502d896ebce6053 Reviewed-by: Zoltan Gera <zoltan.gera@qt.io> Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* doc: Use \keyword to link the versioned cmake macrosDominik Holland2024-09-051-6/+6
| | | | | | | | | \keyword need to be used instead of \target to make the versioned cmake macros also show up in the qhp files and be supported in QC as well. Change-Id: Ibf0f9dfb458312ebfe42671aefa630759f2fe9c7 Pick-to: 6.8 6.7 6.5 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Update the the recommended CMake usage documentationDominik Holland2024-07-261-1/+11
| | | | | | | Pick-to: 6.8 Change-Id: I5f6cd2a9d4e2f81ad09d609dd4c9d1d5a654cf8d Reviewed-by: Zoltan Gera <zoltan.gera@qt.io> Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Update the "What's New" Page with 6.8 changesDominik Holland2024-07-263-1/+30
| | | | | | | Pick-to: 6.8 Fixes: QTBUG-126693 Change-Id: I0b2b3459ffff112ebcc59a772f9edf29c5a3048f Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Doc: Fix broken link to the remote exampleDominik Holland2024-07-261-2/+2
| | | | | | | Pick-to: 6.8 Change-Id: I2e7d7609079ea439f8e2ed2314aa73447db887a6 Reviewed-by: Zoltan Gera <zoltan.gera@qt.io> Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Remove some of the default tagsDominik Holland2024-07-101-1/+1
| | | | | | Pick-to: 6.8 Change-Id: Ib1c19dd8714dcfa3126589b4a1e721c31f28bf39 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* CMake: Change default output dir of qt_ifcodegen_add_qml_moduleDominik Holland2024-06-251-0/+2
| | | | | | | | | The new default OUTPUT_DIRECTORY is now the URI with dots replaced by forward slashes. Pick-to: 6.8 Change-Id: I1a3b069483ca7d37731effc49d3fb0d5f537ed12 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Add documentation for thew QIfConfiguration variablesDominik Holland2024-06-201-0/+4
| | | | | | Pick-to: 6.8 Change-Id: Ifacfe15069e0f6d010c54543381af76800bcd5a4 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Add documentation for the new asynchronous backend loading featureDominik Holland2024-06-191-0/+3
| | | | | | Pick-to: 6.8 Change-Id: I9f9474167d61c96bf00427baf34e667f86e8018e Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Use Python venv instead of virtualenv everywhereZoltan Gera2024-06-051-1/+1
| | | | | | | | | | | | | | | | Python has venv in its standard library set, so using it instead of the virtualenv package can make virtual environment deployment easier with less dependencies used. The newer venv package is now used for both compiled and interpreted workflows. Instead of making virtual environments relocatable, they are distributed with a generated requirements file which makes it possible for them to be regenerated after relocation. Fixes: QTBUG-104239 Pick-to: 6.8 Change-Id: I7795457be74637188ad1b1c448cca117491e4799 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* CMake: Deprecate the IMPORT_PATH function argumentDominik Holland2024-05-291-5/+5
| | | | | | | | | | The new argument is named IDL_IMPORT_PATH. The argument needs to be renamed as it clashes with the IMPORT_PATH of qt_add_qml_module. Otherwise the IMPORT_PATH argument is not forwarded correctly to qt_add_qml_module in the new qt_ifcodege_add_qml_module function. Change-Id: I2b857579b26c063c4a423afab7880a1c56d38a1d Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* CMake: Add a new qt_ifcodegen_add_qml_module functionDominik Holland2024-05-292-0/+65
| | | | | | | | | | This makes it easier to generate qml modules as it will take the URI and VERSION from the ifcodegen template, but also allows to be passed to the function to overwrite the values. Fixes: QTBUG-118780 Change-Id: I15b2f06c6ac8373286d002dc64d8d34941df11df Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* CMake: Add a new qt_ifcodegen_add_plugin functionDominik Holland2024-05-292-1/+66
| | | | | | | | | | This makes it easier to generate backend plugins while making sure those plugins are of the correct type and use the correct class name to support static linking. Fixes: QTBUG-123370 Change-Id: I4f32cce7df308bbe320a2063b5a9840de77a050f Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Also list the generated CMake files in the template documentationDominik Holland2024-02-071-12/+42
| | | | | | | Fixes: QTBUG-121696 Pick-to: 6.7 6.6 6.5 Change-Id: Iaccd3adc1b4f12d6406ba6fed36328e2547dea71 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Fix broken links and code embeddingsDominik Holland2024-02-071-1/+1
| | | | | | | | Fixes: QTBUG-121740 Fixes: QTBUG-121778 Pick-to: 6.7 6.6 6.5 Change-Id: Ia165a8a95a67f8a47d5f17380d2ae888cdf2d6da Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Fix 'Environment Overrides' link in the Configuration pageDominik Holland2024-01-221-2/+2
| | | | | | Pick-to: 6.7 Change-Id: Iff170604804253918c0b7f42f2c2069d6cc8fb54 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Fix the QtIfRemoteObjectsHelper module page and make it visibleDominik Holland2024-01-194-0/+52
| | | | | | Pick-to: 6.7 Change-Id: I2b2a42e026ec8926dbcba66817548293bfafe02c Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Add new environment variables to the configuration doc pageDominik Holland2024-01-191-0/+8
| | | | | | Pick-to: 6.7 Change-Id: If49197cbf598654c788c841ff18e8003c0103c12 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Update the "What's New" Page with 6.7 changesDominik Holland2024-01-194-4/+14
| | | | | | Pick-to: 6.7 Change-Id: I5f9a25e28582f367210e5b185cc8b2d1ae9dba18 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Fix broken links and other warningsDominik Holland2024-01-195-10/+6
| | | | | | Pick-to: 6.7 Change-Id: Ibf517f31f0c5c6f391c46f2dda4beff23f34795d Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Remove Reference API related codeDominik Holland2023-11-289-143/+21
| | | | | | | | | | | | | | The modules ifmedia and ifvehiclefunctions just act as a reference and having the code in the same repository makes things more complicated, as they are build automatically although not needed for most users and they are also part of the same documentation and gives the wrong impression about what the qtinterfaceframework module really is about. Fixes: QTBUG-99002 Change-Id: I867e1e26438ee2200e82d5b742c666ba48ae9c02 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Remove the Extending Qt Interface Framework pageDominik Holland2023-11-232-109/+0
| | | | | | | | | The page was outdated and just repeated what's already explained in other places. Fixes: QTBUG-99001 Change-Id: Iffa865665a9fe07b005a64b68b18f7fd64fff75e Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* ifcodegen: Add a autogenerated main to server_qtroDominik Holland2023-11-131-1/+23
| | | | | | | | | | | | | | | | It can be used using a module annotation and generates a main.cpp with the same command-line arguments as the server_qtro_simulator. The generated main instantiates a QIfRemoteObjectsConfig which is forwarded to a serverMain() function, which needs to be implemented by the user. The provided config instance, can be used to enable remoting of the services. Task-number: QTBUG-113105 Change-Id: Ief94ea11be96453f306c712c2115854837d054f8 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Promote the QtIfRemoteObjectsHelper lib to a proper qt moduleDominik Holland2023-11-133-1/+7
| | | | | | | | | | | Instead of being a static private library it is now a dynamic library with public code including documentation. This makes it possible to host more code which is QtRemoteObjects specific. Change-Id: I3ff601add349d4fad721890c12fc6e59fbe4ee79 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Remove double listing of all C++ classesDominik Holland2023-11-131-20/+0
| | | | | | | | A link to the module page should be enough. Change-Id: Ib9e6b54efba96c5bad2dde3c7f80434569993df3 Reviewed-by: Robert Griebl <robert.griebl@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Documentation updateDominik Holland2023-09-296-49/+46
| | | | | | | | | | | | | | | * Make the documentation less automotive specific * Give more examples where the zones concept is useful * Add a better overview documentation to: QIfAbstractZonedFeature QIfZonedFeatureInterface QIFeatureInterface Task-number: QTBUG-99004 Task-number: QTBUG-116203 Pick-to: 6.6 6.6.0 Change-Id: Icef354f97c5bf504abb3b93886e9866ed185e3d9 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Rework the buildsystem integration pageDominik Holland2023-09-293-54/+33
| | | | | | | | Also fixed some typos and linking errors Pick-to: 6.5 6.6 6.6.0 Change-Id: I200bc0c6e1578a84eea8f9d901e1e5f1fc50d2e3 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Update the "What's New" Page with 6.6 changesDominik Holland2023-09-082-1/+11
| | | | | | Change-Id: Ic9b3aa0ea1e9a4aa6d6e35d35fb6fc808c90162b Pick-to: 6.6 Reviewed-by: Bernd Weimer <bernd.weimer@qt.io>
* ifcodegen: Improve the settings parsing in the backend_qtro templateDominik Holland2023-07-201-4/+6
| | | | | | Pick-to: 6.5 6.6 Change-Id: I2e2798461f53556a449ae6887bd8f099c4965e6b Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* ifcodegen: Add an option for 'unsupported' properties in the config_simulatorDominik Holland2023-07-171-0/+10
| | | | | | | | | | This is useful to e.g. disable properties on certain zones. The QIfSimulationEngine has support for quite some time, this just adds a way to generate the simulationData from a qface annotation. Pick-to: 6.6 Change-Id: I816d73c052de5078ff37879f14b3bd2b7b9e452d Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Documentation: fix link targets inside of tablesRobert Griebl2023-07-141-5/+5
| | | | | | | | | | A \target directly after a \row is generated as a <span> within a <tr>. This is invalid HTML, so these link targets are relocated to the start of the table by both Chrome and Firefox. Pick-to: 6.5 6.6 Change-Id: I3933e875007fc499166f65112214320aa580bdde Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Fix documentation warningsTopi Reinio2023-06-214-4/+7
| | | | | | | | | | | | | | | | | | Add #includes for QIfClimateControlBackendInterface and QIfWindowControlBackendInterface to the documentation-specific master header - this fixes multiple 'clang couldn't find function' warnings when generating docs. In addition, fix the following warnings: * cmake-macros.qdoc:25: Unknown macro 'c' * filter-reference.qdoc:6: Can't link to 'namespace_prefix' * filter-reference.qdoc:6: Can't link to 'add_namespace_prefix' * generator-usage.qdoc:5: Can't link to 'server_qtro_simulator' Pick-to: 6.6 6.5 Change-Id: I522f6905d51cf43135609585232796803dcc4141 Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* Doc: Update link to Jinja template documentationPaul Wicking2023-05-091-1/+1
| | | | | | | | | | | The link to Jinja's template documentation points to a page that has been moved or removed since Qt's documentation was written. Update the link such that it points to Jinja's Template Designer documentation. Touch the words leading up to the link for readabilitiy purposes. Fixes: QTBUG-113429 Change-Id: Iaf63c6beb3c01efb47f35c8aa3685ad79d644acb Reviewed-by: Dominik Holland <dominik.holland@qt.io>
* doc: Improve the QIfConfiguration related documentationDominik Holland2023-05-031-12/+22
| | | | | | | | | | | | | | | The configurationId annotation documenation had some short comings. It now should give you some more help were it can be used and what the default value is. The QtRO related serviceSettings now use a complete QML example. The InterfaceFrameworkConfiguration documentation now also provides a example on how serviceSettings can be used. Pick-to: 6.5 Change-Id: I5349efdc6b03952e395b506523bd1e1872302158 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Add a "What's New" Page with all new featuresDominik Holland2023-02-153-0/+43
| | | | | | Pick-to: 6.5 Change-Id: Icf3fe3cda8cf64cec4d1c1cf1543af24638b734f Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Add QIfConfiguration based settings to the autogenerated codeDominik Holland2023-01-241-2/+107
| | | | | | | | | | | | | | * Exposes the serviceSettings as property of the backend to the QML simulation * Adds a way to set and change the connectionUrl for every backend * If the connectionUrl changes the QtRO node will be reconnecting to the new url * Adds a setting to define the connectionTimeout Task-number: QTBUG-99079 Pick-to: 6.5 Change-Id: I277e304b31bed0073f559b79eec64cf47cf8260f Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Add documentation for the new featuresDominik Holland2023-01-171-1/+1
| | | | | | Pick-to: 6.5 Change-Id: I8db93d48211394f6861fa6c2ba9f19525c9a59c7 Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Fix all paths in the qt_attribution.json filesDominik Holland2023-01-111-1/+1
| | | | | | | | | Some of the files have been moved, but the attribution files were still pointing to the old location. Pick-to: 6.5 6.4 6.2 Change-Id: I6c53e90802775bdad055f3dcf66f4c8124b708e7 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* qface-tutorial: Improve qml plugin codeDominik Holland2022-12-151-1/+1
| | | | | | | | | Also add the CLASS_NAME for static linking and IMPORTS statement for a QML dependency to qt_add_qml_module. Pick-to: 6.4 6.5 Change-Id: Ia12600994b3046104bb1a7128f3ef7e34039543d Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* doc: Ignore qdoc warnings until the new features are documentedDominik Holland2022-12-071-1/+1
| | | | | | Change-Id: Idfdd672746be4902976b387c9d99652d54e296c1 Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Robert Griebl <robert.griebl@qt.io>
* Doc: Fix link to CMake Commands in Qt6 InterfaceFrameworkKai Köhne2022-12-061-1/+1
| | | | | | | | Amends fea34864fd12f812728 Pick-to: 6.4 Change-Id: I326c5b61a9379384e35793d9bd961795cc6c4bce Reviewed-by: Dominik Holland <dominik.holland@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-12-15 23:59:09 +0000