diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2020-11-19 16:39:23 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2020-11-21 03:22:06 +0000 |
| commit | 702aa21390a2a76afcc95000eb63a80301f006a0 (patch) | |
| tree | 44fa242fe9151fa109bc4c1f38bbf1250892344d /src/qml/doc | |
| parent | c47f2f9cb9bff143d15264625b03c1efc5c0695f (diff) | |
Doc: mention that INCLUDEPATH must be set in some cases
Otherwise the generated type registrations .cpp file will not be able
to include the sources.
Change-Id: I7821c7674b4341546da2fc49e584bf10cc60b46f
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
(cherry picked from commit 06c31f386f8664343debd219a522a8897df0f3ec)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/cppintegration/definetypes.qdoc | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc index 5098f74df8..1d52f18981 100644 --- a/src/qml/doc/src/cppintegration/definetypes.qdoc +++ b/src/qml/doc/src/cppintegration/definetypes.qdoc @@ -117,6 +117,14 @@ QML_IMPORT_NAME = com.mycompany.messaging QML_IMPORT_MAJOR_VERSION = 1 \endcode +If the header the class is declared in is not accessible from your project's +include path, you may have to amend the include path so that the generated +registration code can be compiled: + +\code +INCLUDEPATH += com/mycompany/messaging +\endcode + The type can be used in an \l{qtqml-syntax-basics.html#object-declarations} {object declaration} from QML, and its properties can be read and written to, as per the example below: |