summaryrefslogtreecommitdiffstats
path: root/src/compositor/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Use canonical help namespaceKai Koehne2018-06-211-1/+1
| | | | | | Change-Id: I90bec25232a0b856df18755ab7e576e80d7191ea Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
* Doc: Add documentation dependency to Qt CoreTopi Reinio2018-01-121-1/+1
| | | | | | | | | | | | QDoc generates the following note for a number of functions: 'Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.' Q_INVOKABLE is meant to be a link which fails without Qt Core. Change-Id: Id67120e37992c671c954b04309e9fd253bf184e1 Reviewed-by: Martin Smith <martin.smith@qt.io>
* Merge remote-tracking branch 'qt/5.9' into 5.10v5.10.0-beta3Paul Olav Tvete2017-10-254-20/+20
|\ | | | | | | Change-Id: I6c283081669594b3e8c6b30194bb96e389319cb2
| * Fix outdated FDL license headerKai Koehne2017-10-204-20/+20
| | | | | | | | | | Change-Id: Id4ba079514c7844821adac3c0c108af7deb57889 Reviewed-by: Jani Heikkinen <jani.heikkinen@qt.io>
* | Docs: Bump compositor module version to 1.1v5.10.0-beta2Johan Klokkhammer Helsing2017-10-131-2/+2
| | | | | | | | | | Change-Id: Icbb93367f2d9f08261b450c97f9e7fb1820b4ee3 Reviewed-by: Pier Luigi Fiorini <pierluigi.fiorini@liri.io>
* | doc: Expand the overview docs of Qt Wayland CompositorEskil Abrahamsen Blomfeldt2017-09-261-4/+52
|/ | | | | | | | | | | There is some confusion with regards to what types of features the Wayland Compositor provides and how it related to application managers. This tries to expand the entry point description in the docs to give a more detailed description. Change-Id: I96f58c04646c69575a1bd4e4b9178c5722d752d6 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Johan Helsing <johan.helsing@qt.io>
* Doc: Drop the dummy "Tech. Preview" node from the navigation breadcrumbVenugopal Shivashankar2016-11-241-1/+0
| | | | | | | Qt Wayland Compositor is a fully supported add-on module now. Change-Id: Icd742e019be4b516227f9e4a976dcd87014e3251 Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
* Document 3rd party code in Qt WaylandKai Koehne2016-10-041-0/+14
| | | | | | | | | Unfortunately the QPA plugin for Qt Wayland does not have a dedicated help, which is why everything is right now crammed into the compositor documentaton. Change-Id: Iddc4d67a817f2cc3bb334b2f040fa55230b5da4f Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Language editsVenugopal Shivashankar2016-08-171-14/+20
| | | | | | | Task-number: QTBUG-53147 Change-Id: I353cf18b9661b5eb2371072f8091dc890fc7fcf0 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: fixed issue compiling qtwaylandcompositor.htmlNico Vertriest2016-07-011-5/+8
| | | | | | | Added 2 cpp.ignoretokens statements Change-Id: I0f86ba94682b6f9fc0e76484a14ece7c39ff436a Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io>
* Doc: minor link issues QtWaylandNico Vertriest2016-06-211-1/+1
| | | | | | Change-Id: I5ea47a8252f2915696d02052686f2c802a81878c Reviewed-by: Frederik Gladhorn <frederik.gladhorn@qt.io> Reviewed-by: Johan Helsing <johan.helsing@qt.io>
* Doc: Rename the qdocconf to match the doc project nameVenugopal Shivashankar2015-12-151-0/+0
| | | | | | | | qmake assumes that the conf file name and the project name are same, so 'make docs' fail if they are different. Change-Id: Ic4784524c50cd085096fbf8853138b48d818fd61 Reviewed-by: Topi Reiniö <topi.reinio@theqtcompany.com>
* Doc: Change a few parameter values in the qdocconfVenugopal Shivashankar2015-11-112-12/+9
| | | | | | | | | | The waylandcompositor API will be part of Qt so the docs for it should use the Qt reference documentation URL and version. The index page for the module cannot be named 'index.html' as it conflicts with the Qt reference doc main page. Change-Id: I3d8c45dac7a896e9bd6a2ab5f1c6d4f7018810ed Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
* Add documentation to Qt Wayland CompositorEskil Abrahamsen Blomfeldt2015-10-265-0/+253
This adds some preliminary documentation for the Qt Wayland Compositor. There are a few classes which remain undocumented. The documentation in some areas may be a bit minimal, but this can be expanded gradually with code examples and more details. Change-Id: I5d285a5a25e8602ac2fdddc84c3fd217e7b77c95 Reviewed-by: Paul Olav Tvete <paul.tvete@theqtcompany.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@theqtcompany.com>