summaryrefslogtreecommitdiffstats
path: root/src/remoteobjects/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix incorrect class name from SwitchState to SimpleSwitchDheerendra Purohit2025-06-071-1/+1
| | | | | | | | | | | | | Fixes a typo in the Remote Objects static source example where SwitchState was incorrectly used instead of SimpleSwitch. Improves clarity by matching the class name in the documentation with the actual example code. Fixes: QTBUG-113433 Change-Id: Ia638ea40f937162dc25d5ac4d2a6b3b1fe687153 Reviewed-by: Brett Stottlemyer <brett.stottlemyer@gmail.com>
* Doc: Enable automatic linking to sources on code.qt.ioTopi Reinio2025-05-271-0/+3
| | | | | | | | | | | | Since 6.10, QDoc is capable of generating links to the declaration in the source code for each documented C++ API entity in their `Detailed description`. Add the required configuration to enable this feature in Qt Remote Objects. Change-Id: I5169d888445ee7b96fd1e5ec9a05ee774bd8fb60 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Put qt6_ CMake commands in help indexKai Köhne2024-08-271-4/+4
| | | | | | | | | | Using \keyword instead of \target means that IDE's can properly look up these commands in the qch index. Pick-to: 6.7 6.8 Task-number: QTBUG-128368 Change-Id: I41b46d85e4a45ee371b07ab67ea20e4802b61381 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Docs: Organize topics in the Qt Remote Objects projectAlexei Cazacov2024-08-073-8/+45
| | | | | | | | | | 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-127350 Change-Id: I1650d59c26dd9403f4d118c9435c7a3f5fc9e05b Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Correct license for snippet filesLucie Gérard2024-04-042-2/+2
| | | | | | | | | | | | According to QUIP-18 [1], all example and snippet files 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: I1443b89a271a9ca557276a7c22eaf9e7aa6b40a8 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Correct license for example and snippet filesLucie Gérard2024-04-041-1/+1
| | | | | | | | | | | | According to QUIP-18 [1], all example and snippet files 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: I71c88d1ba956d8e2c03ae2a958eece693ded7bf1 Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Highlight Time Server / Client Application examplesKai Köhne2023-11-161-0/+3
| | | | | | | Task-number: QTBUG-117221 Pick-to: 6.5 6.6 Change-Id: I77f96e9753dfacf1f7308da7537807a8a0bc38a6 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* repc: Add support for #HEADER and #FOOTER linesDominik Holland2023-10-301-0/+19
| | | | | | | | | Those are useful when the generated classes should live inside a namespace. The lines are copied as is and no additional check is done in repc. Change-Id: I95413b953e695a7bc8e95b6653a4ef22ca7c1795 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Add support for class attributes in rep filesDominik Holland2023-10-171-0/+27
| | | | | | | | | This can be used for visibility attributes to export or hide symbols, which is useful when the autogenerated code lives inside a lib. Change-Id: I734f805947dc029929e9e21d79318f4a31be7645 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Document simpleswitch examplesØystein Heskestad2023-10-111-0/+0
| | | | | | | Task-number: QTBUG-112850 Pick-to: 6.6 6.5 Change-Id: I43cc08101153f10c30cd8ffa38649fd8e84ddbd2 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Doc: Fix issues and enable documentation testing in CITopi Reinio2023-10-101-0/+3
| | | | | | | | | | | | | | | examples/remoteobjects/clientapp/doc/src/clientapp.qdoc: Cannot find file to quote from: clientapp/qml/plugins1.qml src/remoteobjects/qremoteobjectnode.cpp: Can't link to 'address' Mark the module free of documentation warnings and enable doc testing in the CI. Change-Id: Ia33991e615e74df54a7cebdfbe0aafe65b0c8cdb Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io> Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Update snippets to match the simpleswitch examples they are taken fromØystein Heskestad2023-08-161-41/+42
| | | | | | | | | | | This is a clean up of the snippets before the simpleswitch examples are removed. Task-number: QTBUG-112850 Pick-to: 6.5 6.6 Change-Id: Ib58676fe8ad95ce52a108cd3a4d986534e2eb1b5 Reviewed-by: Dennis Oberst <dennis.oberst@qt.io> Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Remove \ingroup all-examples command from the docsJaishree Vyas2023-07-121-1/+0
| | | | | | | Task-number: QTBUG-115044 Pick-to: 6.5 6.6 Change-Id: I9da3c45fce9da5100b17c5079dc07128c523b7ef Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Revamp WebSockets exampleØystein Heskestad2023-06-061-0/+0
| | | | | | | | | Fix a warning, expand the documentation, and add a picture to it. Task-number: QTBUG-112850 Pick-to: 6.5 6.6 Change-Id: I203392a95bef206fecc2777d060e215d95235296 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Revamp SSL exampleØystein Heskestad2023-06-061-0/+0
| | | | | | | | | | | | The example did not work because the two applications used different rep-files to generate the remote objects. Use the same file in both applications, fix usage of case in naming, expand the documentation, and add a picture. Remove unused PresetData from rep-file. Task-number: QTBUG-112850 Pick-to: 6.5 6.6 Change-Id: Ia7aafc52d647bca9ffec12b8dd548377f20b6ce4 Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
* Fix connect example in doc sampleCarl Schwan2023-02-213-2/+4
| | | | | | | The timeout signal is from the QTimer class and not SimpleSwitch Change-Id: Idc8034727bc0ab1310f0d62420b7ecb7fc230c48 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Enable QtRemoteObjects example documentationJuha Vuolle2022-09-233-1/+18
| | | | | | | | | | | | | This commit adds the example listing page and a link to it on the module's landing page. The examples that had the 'qdoc' file are included in the listing. Few examples' documentation is quite limited, but those can be addresed in their own tasks as needed. Fixes: QTBUG-105943 Change-Id: Id69baead6fa5a2a62a3ce7fdf3d7e6be06cc851d Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Add QtRO over BT LE exampleBogDan Vatra2022-08-293-1/+2
| | | | | | | | | | | | | | | | | This commit adds Qt remote object example which demonstrates remote objects over Bluetooth Low Energy (LE). The example uses GATT characteristics and their value notifications as the transport method. The source (server) side is a simple "heater" object which is either turned ON or OFF, as controlled by the client. The temperature then changes upwards (heats) or downwards (cools) accordingly. The changing temperature value is shown by the client GUI. Fixes: QTBUG-99576 Change-Id: I70dff545db0e45e3026ed5a7a98fce7bf54b9821 Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Change the license of all CMakeLists.txt and *.cmake files to BSDLucie Gérard2022-08-231-1/+1
| | | | | | | Task-number: QTBUG-105718 Change-Id: I3c41abc9bca22c7395fa8bbacb853e2081491d5f Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Add license headers to cmake filesLucie Gérard2022-07-071-0/+3
| | | | | | | | | | | | CMakeLists.txt and .cmake files of significant size (more than 2 lines according to our check in tst_license.pl) now have the copyright and license header. Existing copyright statements remain intact Task-number: QTBUG-88621 Change-Id: I645192906c25043651ee09447a2d98e70330a39c Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Use SPDX license identifiersLucie Gérard2022-06-1424-717/+48
| | | | | | | | | | | 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: I315d7ce1d6c6c3497afdfe8b61a113fdc181c935 Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: Use find_package(Qt6 REQUIRED COMPONENTS ...) idiomKai Köhne2022-05-131-1/+1
| | | | | | | | | | | Using REQUIRED as a prefix instead of suffix works better with OPTIONAL_COMPONENTS, and is also the order in the CMake manual. Pick-to: 6.3 Task-number: QTBUG-98867 Change-Id: I02034035f8c67a1e55a826898231409c07ebd6bf Reviewed-by: Rui Oliveira Reviewed-by: Jörg Bornemann <joerg.bornemann@qt.io>
* Doc: State Qt versions for when CMake commands etc. were introducedJoerg Bornemann2022-02-091-0/+8
| | | | | | | Pick-to: 6.2 6.3 Task-number: QTBUG-100212 Change-Id: I35220805f85ebadbaffbcb32ae4654271926e155 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* CMake: Bump almost all cmake_minimum_required calls to 3.16Alexandru Croitor2021-09-221-1/+1
| | | | | | | | | | | | | Needed for subsequent change that will check and error out if the version is lower than 3.16. We do that to ensure all policies introduced by CMake up to version 3.16 have their behavior set to NEW. Pick-to: 6.2 Task-number: QTBUG-95018 Change-Id: Iae47a29fea5ea6a14a7c7fb5528be02c40bbe617 Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* 6.2 cleanupBrett Stottlemyer2021-09-081-0/+3
| | | | | | | | | | | | | | Several cleanup fixes prior to 6.2 release: * Bump the protocol version: several earlier patches are incompatible with version 1.3. * Set the datastream format to little endian. Most machines are LE, so this prevents unnecessary byte-swapping. * Use 6.2 datastream format * Update compatibility table in the documentation. Pick-to: 6.2 6.2.0 Change-Id: I3a96513d9edf351ee30f49bad237005878b54b8a Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
* Provide a schema for abstract local socketsBrett Stottlemyer2021-08-311-8/+16
| | | | | | | | | | | | | | | | Adds 'localabstract' schema, an extension of the 'local' schema. An abstract Unix domain socket (which is a non-portable Linux extension) avoids creating a file handle for local socket communication. This allows abstract sockets to run on systems that are non-writable, in particular Android environments. Pick-to: 6.2 Fixes: QTBUG-96006 Change-Id: I9f7f7854708264c38d05d704f3569bcc9e46cfbf Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org> Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Doc: Fix linking warning to 'qmake'Topi Reinio2021-08-261-1/+2
| | | | | | | Pick-to: 6.2 Task-number: QTBUG-95860 Change-Id: I73dc7e92d7613bae9f21f22b3d621e692434b63f Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Remove unsupported customFiltersKai Köhne2021-08-251-3/+0
| | | | | | Task-number: QTBUG-95987 Change-Id: I49e397a9fb3607bb9e6d477d0f81d93802b86317 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Clean up Qt RemoteObjects documentationSona Kurazyan2021-08-175-11/+16
| | | | | | | | | | | | | - Rename Remoteobjects -> RemoteObjects - Fix the import version for QML types - Add a "Using the Module" section, as it is done for most of the modules. - Other minor fixes Pick-to: 6.2 Fixes: QTBUG-94899 Change-Id: If522b0c73994f59a84821fb35d13c11a5d80c172 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add thumbnail images to the example docsVenugopal Shivashankar2021-08-171-0/+6
| | | | | | | | Task-number: QTBUG-95860 Pick-to: 6.2 Change-Id: I14d166d1125251ea949ddcc463aae44299609922 Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Restructure CMake API docs to add them to the main CMake docs pageSona Kurazyan2021-08-062-60/+151
| | | | | | | | | | | | | | | | | The main CMake command reference page for all modules uses annotated lists of items that are grouped together (for example, see the link in the bugreport). It has an entry for QtRemoteObjects, but there's no group with the name it links to, so the docs don't show up. Moved the docs for each QtRemoteObjects CMake functions to separate pages, which are grouped as the main CMake doc page expects. This makes CMake API docs for QtRemoteObjects consitent with the docs for other modules. Pick-to: 6.2 Task-number: QTBUG-95433 Change-Id: Ia6ebe1a825ec9bcdfb4628b92a32ad31d3938e24 Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Use correct documentation groupPaul Wicking2021-08-041-2/+2
| | | | | | | Task-number: QTBUG-94904 Pick-to: 6.2 Change-Id: I372399728e9dbfc95a638e58f149858e293960a3 Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Rename qt6_rep_from_headers -> qt6_reps_from_headersSona Kurazyan2021-08-032-3/+3
| | | | | | | | | This function generates multiple .rep files in case if multiple headers are passed, so `qt6_reps_from_headers` is a better name. Pick-to: 6.2 Change-Id: I71967f40ec38c817d4414d2470728168a7da06b5 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* CMake: make qt_rep_from_header function pluralSona Kurazyan2021-08-022-3/+3
| | | | | | | | | It can take multiple header files. Pick-to: 6.2 Change-Id: I0105000d63cf06448b2373517d37bfb65fcbf8fb Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Document the qt6_rep_from_header CMake functionSona Kurazyan2021-07-152-0/+19
| | | | | | Pick-to: 6.2 Change-Id: I8de0df11e7409cd76d9919cd0bc676703d27564a Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Document the renamed classes in the porting guideSona Kurazyan2021-06-171-0/+15
| | | | | | | | Pick-to: 6.2 Change-Id: I0ed937d1ff73b917bf46bd1385e4bcacd9068d7a Reviewed-by: Brett Stottlemyer <bstottle@ford.com> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
* Document the SC and BC guarantees for APIs from qconnectionfactories.hSona Kurazyan2021-06-172-1/+70
| | | | | | | | | | | Updated the warning in qconnectionfactories.h to mention source and binary compatibility guarantees for the classes exported by that header. Added a short overview documentation for these classes. Pick-to: 6.2 Change-Id: Iabeb865908ca05ced1bfb191971806e291915e7e Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Make qt6_add_repc_{replica, source} pluralSona Kurazyan2021-05-313-9/+9
| | | | | | | | | Since these functions can take multiple *.rep files, it makes sense to make them plural. Change-Id: I99894e9ee1f6f0035eb8c3e5cdd1292316324577 Reviewed-by: Michael Brasser <michael.brasser@live.com> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Update porting guide with CMake instructions for repc-generationSona Kurazyan2021-05-281-0/+32
| | | | | | | Task-number: QTBUG-93855 Change-Id: I7337288310fac94ef4ec289fa105bbed37a44720 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Document the CMake commands for running repc compilerSona Kurazyan2021-05-286-74/+109
| | | | | | | | | | | Also added the missing instructions for adding the QtRemoteObjects module to a CMake-based project and removed the docs for qt5_generate_repc macro. Task-number: QTBUG-93855 Change-Id: I5116dacba76674217421657dfc404442e3f12701 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Remove QMake project filesSona Kurazyan2021-04-162-7/+1
| | | | | | | | | | | | | | Removed *.pro/*.pri files for sources and tests, we still want to keep them for examples. This patch also removes: - .prev_CMakeLists.txt files - "#special case" and "# Generated from" markers Task-number: QTBUG-88742 Change-Id: I004c8de6048174a1e6db938cf70d1c05369f28d1 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Update QML plugin for QtRemoteObjectsSona Kurazyan2021-04-161-5/+5
| | | | | | | | | | Port the plugin to the new QML type registration system. Due to QML element registration via QML_ELEMENT* and friends, plugins.qmltypes is not needed anymore (it's generated). Also no need in setting the module import versions manually, so update the docs accordingly. Change-Id: Idf67ac9a53d00564501e1d8b9f2f296c27bed58a Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Document the modelviewclient and server examplesMårten Nordheim2021-03-241-2/+2
| | | | | | | | | | | | They're simple, which makes them easy to follow. Adjusted the qtremoteobjects.qdocconf file as it wasn't working with the examples on my Linux machine at least. Task-number: QTBUG-90848 Change-Id: Id674585835717be87344f3f694ab77128ecb5344 Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add the Qt 6 porting guideMårten Nordheim2021-03-111-0/+54
| | | | | | | | | With the known differences so far Task-number: QTBUG-90848 Change-Id: I18bfc6e32b7dc6a5ff56b431f5a65ceea6c19a43 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
* Various documentation fixesMårten Nordheim2021-03-091-1/+1
| | | | | | | | | | Reflowed very long lines. 0 meaning 'nullptr' changed to \nullptr. Typos fixed. Task-number: QTBUG-90848 Change-Id: Ieeae60047203dee829adae84c900692aa94a45e3 Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io>
* Migrate from old signal/slot connection syntax (part 2)Sona Kurazyan2021-02-261-5/+5
| | | | | | | | | Change the syntax also for the connections that involve types that are defined in the repc-generated files. Pick-to: 5.15 5.12 Change-Id: I222a59c8fae438c5f0026e66a75d0fa905e49ccf Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Migrate from old signal/slot connection syntaxSona Kurazyan2021-02-252-3/+4
| | | | | | | | | | Exception is made for the cases, when the signals/slots are not known at compile-time (i.e. involve dynamic replicas) or are defined in the repc-generated files. Pick-to: 5.15 5.12 Change-Id: Ice1fc78b59c713480531292a0401795df75523d7 Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Doc: remove extra close parenthesesTasuku Suzuki2021-02-162-2/+2
| | | | | Change-Id: Ide3e33437a7cf3a6378a48b9390fc36dbb669b38 Reviewed-by: Michael Brasser <michael.brasser@live.com>
* Mark a couple of TODO itemsBrett Stottlemyer2020-06-291-1/+1
| | | | | | Change-Id: I4426e6a27ce666a0d0090b2f21a16242aec302b5 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
* Doc: Update docs with cmake package informationNico Vertriest2020-06-251-0/+1
| | | | | | Task-number: QTBUG-85179 Change-Id: I429d89f599c83a11a5f0b6a5c545b83fe9ff5bcf Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
generated by cgit v1.2.3 (git 2.25.1) at 2025-08-12 10:25:39 +0000