summaryrefslogtreecommitdiffstats
path: root/src/remoteobjects/doc/qtremoteobjects.qdocconf
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Docs: Organize topics in the Qt Remote Objects projectAlexei Cazacov2024-08-071-7/+18
| | | | | | | | | | 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>
* 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>
* 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>
* Enable QtRemoteObjects example documentationJuha Vuolle2022-09-231-1/+4
| | | | | | | | | | | | | 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-291-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>
* 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-171-1/+2
| | | | | | | | | | | | | - 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>
* 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>
* Doc: Replace example file lists with links to code.qt.ioTopi Reinio2019-07-091-0/+1
| | | | | | Task-number: QTBUG-74391 Change-Id: I30ef9dd40341c802831df426a16f62ee73b1aa6c Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add basic documention for use from QMLMichael Brasser2018-08-241-0/+1
| | | | | | Change-Id: I67796e37cb1299702074cdbc240c85afe13df68e Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Doc: Clean up the Getting Started documentationTopi Reinio2017-03-071-1/+1
| | | | | | | | | | - Edit language and formatting. - Fix terminology: Use lower-case terms (signal, slot, node, ...) unless linking. - Simplify subsection hierarchy, use ordered lists instead. Change-Id: I699173912bc22b41ce1b0c136ff6fe5e5a092a1e Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Introduce documentationBrett Stottlemyer2015-03-201-8/+12
| | | | | | | | | Adding high-level documentation for Remote Objects Change-Id: I69a41476aa4290cf22214ab3079928a81a08b313 Reviewed-by: Björn Breitmeyer <bjoern.breitmeyer@kdab.com> Reviewed-by: Manpreet Bajwa <mbajwa3@ford.com> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>
* Say hello to QtRemoteObjectsBrett Stottlemyer2014-10-161-0/+43
This is a module that allows you to create copies/replicas of your QObjects in other processes, without having to write a bunch of IPC code. Change-Id: I4a62f120eca34c9f50089b7d9d09dcfcad14476c Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@theqtcompany.com> Reviewed-by: Björn Breitmeyer <bjoern.breitmeyer@kdab.com> Reviewed-by: Brett Stottlemyer <bstottle@ford.com>