Doc: Fix qdoc compilation errors qtbase

Task-number: QTBUG-79824 Change-Id: I5a39525e3e735415ba96e2d585c5de754deb15de Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
2020-01-15 14:38:14 +01:00 · 2020-01-15 14:38:14 +01:00 · 28f95d4688
commit 28f95d4688
parent 89312b2eab
15 changed files with 16 additions and 22 deletions
--- a/qmake/doc/qmake.qdocconf
+++ b/qmake/doc/qmake.qdocconf
@ -47,7 +47,7 @@ depends += \
    qtnetwork \
    qtopengl \
    qtprintsupport \
-    qtqml \
+    qtqml qtqmltest \
    qtquick \
    qtquickcontrols \
    qtquickdialogs \
--- a/qmake/doc/src/qmake-manual.qdoc
+++ b/qmake/doc/src/qmake-manual.qdoc
@ -5443,8 +5443,8 @@
        \li The exit code of the test will be ignored during \c{make check}.
    \endtable

-    Test cases will often be written with \l{QTest} or \l[QML]{TestCase}, but
-    that is not a requirement to make use of \c{CONFIG+=testcase} and \c{make check}.
+    Test cases will often be written with \l{QTest} or \c{TestCase}, but
+    it is not a requirement to make use of \c{CONFIG+=testcase} and \c{make check}.
    The only primary requirement is that the test program exit with a zero exit code
    on success, and a non-zero exit code on failure.

--- a/src/corelib/doc/qtcore.qdocconf
+++ b/src/corelib/doc/qtcore.qdocconf
@ -26,7 +26,7 @@ qhp.QtCore.subprojects.classes.sortPages = true

 tagfile                 = ../../../doc/qtcore/qtcore.tags

-depends                 += activeqt qtdbus qtgui qtwidgets qtnetwork qtdoc qtmacextras qtquick qtlinguist qtdesigner qtconcurrent qtxml qmake qtwinextras qtqml
+depends                 += activeqt qtdbus qtgui qtwidgets qtnetwork qtdoc qtmacextras qtquick qtlinguist qtdesigner qtconcurrent qtxml qmake qtwinextras qtqml qtcmake

 headerdirs  += ..

--- a/src/corelib/doc/src/qtcore-index.qdoc
+++ b/src/corelib/doc/src/qtcore-index.qdoc
@ -56,7 +56,7 @@
    \include module-use.qdocinc using qt module
    \quotefile overview/using-qt-core.cmake

-    See also the \l[QtDoc]{Build with CMake} overview.
+    See also the \l{Build with CMake} overview.

    \section2 Building with qmake

--- a/src/corelib/global/qendian.cpp
+++ b/src/corelib/global/qendian.cpp
@ -192,7 +192,6 @@ QT_BEGIN_NAMESPACE
    an in-place swap (if necessary). If they are not the same, the memory
    regions must not overlap.

-    \sa qFromLittleEndian()
    \sa qToBigEndian()
    \sa qToLittleEndian()
 */
--- a/src/corelib/time/qcalendar.cpp
+++ b/src/corelib/time/qcalendar.cpp
@ -723,7 +723,7 @@ QCalendar::QCalendar(QLatin1String name)
 QCalendar::QCalendar(QStringView name)
    : d(QCalendarBackend::fromName(name)) {}

-/*
+/*!
    \fn bool QCalendar::isValid() const

    Returns true if this is a valid calendar object.
--- a/src/corelib/time/qtimezone.cpp
+++ b/src/corelib/time/qtimezone.cpp
@ -217,7 +217,7 @@ Q_GLOBAL_STATIC(QTimeZoneSingleton, global_tz);

    This class includes data obtained from the CLDR data files under the terms
    of the Unicode Data Files and Software License. See
-    \l{Unicode Common Locale Data Repository (CLDR)} for details.
+    \l{unicode-cldr}{Unicode Common Locale Data Repository (CLDR)} for details.

    \sa QDateTime
 */
--- a/src/dbus/qdbusabstractinterface.cpp
+++ b/src/dbus/qdbusabstractinterface.cpp
@ -696,7 +696,7 @@ void QDBusAbstractInterface::internalPropSet(const char *propname, const QVarian
 */

 /*!
-    \fn QDBusAbstractInterface::call(const QString &message, Args&&...args)
+    \fn template <typename...Args> QDBusMessage QDBusAbstractInterface::call(const QString &method, Args&&...args)

    Calls the method \a method on this interface and passes \a args to the method.
    All \a args must be convertible to QVariant.
@ -745,7 +745,7 @@ QDBusMessage QDBusAbstractInterface::call(const QString &method, const QVariant
 */

 /*!
-    \fn QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &message, Args&&...args)
+    \fn template <typename...Args> QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &method, Args&&...args)

    \overload

@ -827,7 +827,7 @@ QDBusMessage QDBusAbstractInterface::call(QDBus::CallMode mode, const QString &m
 */

 /*!
-    \fn QDBusAbstractInterface::asyncCall(const QString &message, Args&&...args)
+    \fn template <typename...Args> QDBusPendingCall QDBusAbstractInterface::asyncCall(const QString &method, Args&&...args)

    Calls the method \a method on this interface and passes \a args to the method.
    All \a args must be convertible to QVariant.
--- a/src/dbus/qdbuspendingcall.cpp
+++ b/src/dbus/qdbuspendingcall.cpp
@ -82,8 +82,7 @@ QT_BEGIN_NAMESPACE
          provide a method of detaching the copies (since they refer
          to the same pending call)

-    \sa QDBusPendingReply, QDBusPendingCallWatcher,
-        QDBusAbstractInterface::asyncCall()
+    \sa QDBusPendingReply, QDBusPendingCallWatcher
 */

 /*!
@ -115,7 +114,7 @@ QT_BEGIN_NAMESPACE
    (one string and one QByteArray), QDBusPendingReply::isError() will
    return true.

-    \sa QDBusPendingReply, QDBusAbstractInterface::asyncCall()
+    \sa QDBusPendingReply
 */

 /*!
--- a/src/dbus/qdbuspendingreply.cpp
+++ b/src/dbus/qdbuspendingreply.cpp
@ -91,8 +91,7 @@
    QDBusPendingCallWatcher objects, which emit signals when the reply
    arrives.

-    \sa QDBusPendingCallWatcher, QDBusReply,
-        QDBusAbstractInterface::asyncCall()
+    \sa QDBusPendingCallWatcher, QDBusReply
 */

 /*!
--- a/src/gui/doc/qtgui.qdocconf
+++ b/src/gui/doc/qtgui.qdocconf
@ -41,6 +41,7 @@ depends += \
    qtwidgets \
    qtdoc \
    qmake \
+    qtcmake \
    qttestlib

 headerdirs  += ..
--- a/src/gui/kernel/qwindow.cpp
+++ b/src/gui/kernel/qwindow.cpp
@ -2690,7 +2690,6 @@ QOpenGLContext *QWindowPrivate::shareContext() const
    platform dependent and untested.

    \sa setParent()
-    \sa setTransientParent()
 */
 QWindow *QWindow::fromWinId(WId id)
 {
--- a/src/gui/painting/qbackingstore.cpp
+++ b/src/gui/painting/qbackingstore.cpp
@ -220,8 +220,6 @@ static bool isRasterSurface(QWindow *window)
    to the backingstore's top level window.

    You should call this function after ending painting with endPaint().
-
-    \sa QWindow::transientParent()
 */
 void QBackingStore::flush(const QRegion &region, QWindow *window, const QPoint &offset)
 {
--- a/src/gui/painting/qpainter.cpp
+++ b/src/gui/painting/qpainter.cpp
@ -1404,8 +1404,7 @@ void QPainterPrivate::updateState(QPainterState *newState)
    cases where expensive operations are ok to use, for instance when
    the result is cached in a QPixmap.

-    \sa QPaintDevice, QPaintEngine, {Qt SVG}, {Basic Drawing Example},
-        {Drawing Utility Functions}
+    \sa QPaintDevice, QPaintEngine, {Qt SVG}, {Basic Drawing Example}, {<qdrawutil.h>}{Drawing Utility Functions}
 */

 /*!
--- a/src/gui/rhi/qrhimetal.mm
+++ b/src/gui/rhi/qrhimetal.mm
@ -129,7 +129,7 @@ QT_BEGIN_NAMESPACE
    recording a frame, that is, between a \l{QRhi::beginFrame()}{beginFrame()}
    - \l{QRhi::endFrame()}{endFrame()} or
    \l{QRhi::beginOffscreenFrame()}{beginOffscreenFrame()} -
-    \l{QRhi::endOffsrceenFrame()}{endOffscreenFrame()} pair.
+    \l{QRhi::endOffscreenFrame()}{endOffsrceenFrame()} pair.

    \note The command encoder is only valid while recording a pass, that is,
    between \l{QRhiCommandBuffer::beginPass()} -