diff options
| -rw-r--r-- | coin/module_config.yaml | 1 | ||||
| -rw-r--r-- | src/compositor/compositor_api/qwaylandbufferref.cpp | 5 | ||||
| -rw-r--r-- | src/compositor/doc/qtwaylandcompositor.qdocconf | 3 | ||||
| -rw-r--r-- | src/compositor/extensions/qwaylandpresentationtime.cpp | 12 |
4 files changed, 14 insertions, 7 deletions
diff --git a/coin/module_config.yaml b/coin/module_config.yaml index 3e8b83c5..ab895bf3 100644 --- a/coin/module_config.yaml +++ b/coin/module_config.yaml @@ -12,6 +12,7 @@ instructions: - type: Group instructions: - !include "{{qt/qtbase}}/coin_module_test_template_v3.yaml" + - !include "{{qt/qtbase}}/coin_module_test_docs.yaml" disable_if: condition: or conditions: diff --git a/src/compositor/compositor_api/qwaylandbufferref.cpp b/src/compositor/compositor_api/qwaylandbufferref.cpp index 6302008d..2a5de67d 100644 --- a/src/compositor/compositor_api/qwaylandbufferref.cpp +++ b/src/compositor/compositor_api/qwaylandbufferref.cpp @@ -140,7 +140,7 @@ QWaylandBufferRef &QWaylandBufferRef::operator=(const QWaylandBufferRef &ref) } /*! - \related QWaylandBufferRef + \fn bool QWaylandBufferRef::operator==(const QWaylandBufferRef &lhs, const QWaylandBufferRef &rhs) Returns \c true if \a lhs references the same buffer as \a rhs. Otherwise returns \c{false}. @@ -151,8 +151,7 @@ bool operator==(const QWaylandBufferRef &lhs, const QWaylandBufferRef &rhs) noex } /*! - \fn bool QWaylandBufferRef::operator==(const QWaylandBufferRef &lhs, const QWaylandBufferRef &rhs) - \related QWaylandBufferRef + \fn bool QWaylandBufferRef::operator!=(const QWaylandBufferRef &lhs, const QWaylandBufferRef &rhs) Returns \c false if \a lhs references the same buffer as \a rhs. Otherwise returns \c {true}. diff --git a/src/compositor/doc/qtwaylandcompositor.qdocconf b/src/compositor/doc/qtwaylandcompositor.qdocconf index be4ea55b..febb0524 100644 --- a/src/compositor/doc/qtwaylandcompositor.qdocconf +++ b/src/compositor/doc/qtwaylandcompositor.qdocconf @@ -50,3 +50,6 @@ Cpp.ignoredirectives += Q_DECLARE_LOGGING_CATEGORY navigation.landingpage = "Qt Wayland Compositor" navigation.qmltypespage = "Qt Wayland Compositor QML Types" navigation.cppclassespage = "Qt Wayland Compositor C++ Classes" + +# Enforce zero warnings when building the documentation +warninglimit = 0 diff --git a/src/compositor/extensions/qwaylandpresentationtime.cpp b/src/compositor/extensions/qwaylandpresentationtime.cpp index b17fb597..6f293d75 100644 --- a/src/compositor/extensions/qwaylandpresentationtime.cpp +++ b/src/compositor/extensions/qwaylandpresentationtime.cpp @@ -132,13 +132,17 @@ QWaylandCompositor *QWaylandPresentationTime::compositor() const /*! * \qmlmethod void QWaylandCompositor::PresentationTime::sendFeedback(Window window, int sequence, int sec, int nsec) * - * Interface to notify that a frame is presented on screen. - * If your platform support drm event, page_flip_handler is proper timing to send it. + * Interface to notify that a frame is presented on screen using \a window. + * If your platform supports DRM events, \c page_flip_handler is the proper timing to send it. + * The \a sequence is the refresh counter. \a sec and \a nsec hold the + * seconds and nanoseconds parts of the presentation timestamp, respectively. */ /*! - * Interface to notify that a frame is presented on screen. - * If your platform support drm event, page_flip_handler is proper timing to send it. + * Interface to notify that a frame is presented on screen using \a window. + * If your platform supports DRM events, \c page_flip_handler is the proper timing to send it. + * The \a sequence is the refresh counter. \a tv_sec and \a tv_nsec hold the + * seconds and nanoseconds parts of the presentation timestamp, respectively. */ void QWaylandPresentationTime::sendFeedback(QQuickWindow *window, quint64 sequence, quint64 tv_sec, quint32 tv_nsec) { |