diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2023-10-09 19:11:44 +0000 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2023-10-10 13:02:22 +0000 |
| commit | 13905766a105e8c05fa5ae83b89732b31919e3bf (patch) | |
| tree | c7ba5a291495fba334b0c73b7a760d19968a959a | |
| parent | 05c32802058e65a2ec85321d9c97e18fa38a3c15 (diff) | |
Doc: Fix issues and enable documentation testing in CI
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>
| -rw-r--r-- | coin/module_config.yaml | 1 | ||||
| -rw-r--r-- | examples/remoteobjects/clientapp/doc/src/clientapp.qdoc | 4 | ||||
| -rw-r--r-- | examples/remoteobjects/clientapp/plugins1.qml | 2 | ||||
| -rw-r--r-- | src/remoteobjects/doc/qtremoteobjects.qdocconf | 3 | ||||
| -rw-r--r-- | src/remoteobjects/qremoteobjectnode.cpp | 2 |
5 files changed, 9 insertions, 3 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 16d158c..aaf3323 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -10,3 +10,4 @@ instructions: Test: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" diff --git a/examples/remoteobjects/clientapp/doc/src/clientapp.qdoc b/examples/remoteobjects/clientapp/doc/src/clientapp.qdoc index 644ba94..c8d1fd2 100644 --- a/examples/remoteobjects/clientapp/doc/src/clientapp.qdoc +++ b/examples/remoteobjects/clientapp/doc/src/clientapp.qdoc @@ -53,7 +53,9 @@ and minutes set to the hour and minute properties of \c Time. The "plugins2.qml" file is similar but displays two clocks. - \snippet clientapp/qml/plugins1.qml 0 + \quotefromfile clientapp/plugins1.qml + \skipto /^import/ + \printuntil \sa {Time Server Application} */ diff --git a/examples/remoteobjects/clientapp/plugins1.qml b/examples/remoteobjects/clientapp/plugins1.qml index a7de87e..475050a 100644 --- a/examples/remoteobjects/clientapp/plugins1.qml +++ b/examples/remoteobjects/clientapp/plugins1.qml @@ -1,6 +1,6 @@ // Copyright (C) 2017 Ford Motor Company // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause -//![0] + import QtRemoteObjects import QtQuick import TimeExample // import types from the plugin diff --git a/src/remoteobjects/doc/qtremoteobjects.qdocconf b/src/remoteobjects/doc/qtremoteobjects.qdocconf index 639fc69..7047bf8 100644 --- a/src/remoteobjects/doc/qtremoteobjects.qdocconf +++ b/src/remoteobjects/doc/qtremoteobjects.qdocconf @@ -56,3 +56,6 @@ imagedirs += images navigation.landingpage = "Qt Remote Objects" navigation.cppclassespage = "Qt Remote Objects C++ Classes" navigation.qmltypespage = "Qt Remote Objects QML Types" + +# Enforce zero documentation warnings +warninglimit = 0 diff --git a/src/remoteobjects/qremoteobjectnode.cpp b/src/remoteobjects/qremoteobjectnode.cpp index 8b186a5..cef1e84 100644 --- a/src/remoteobjects/qremoteobjectnode.cpp +++ b/src/remoteobjects/qremoteobjectnode.cpp @@ -2005,7 +2005,7 @@ bool QRemoteObjectHostBasePrivate::setHostUrlBaseImpl( It has no consequence for already listening QRemoteObjectHost objects or QRemoteObjectHost objects that use different backends than QLocalServer. QRemoteObjectHost objects start to - listen during construction if the \l address argument is + listen during construction if the \e address argument is non-empty, otherwise when the address is set via setHostUrl(). \sa setHostUrl(), QRemoteObjectHost() |