From e5bc777e5051a5b24b5e241072042631bd69fc22 Mon Sep 17 00:00:00 2001 From: Volker Hilsheimer Date: Fri, 23 Oct 2020 08:31:30 +0200 Subject: Fix documentation warnings Declare hidden friends like qdoc expects them, and other signature fixes Document function parameters Remove documentation for removed APIs. Change-Id: I44c1caeed0d40be04612129d074acc30b75f5259 Reviewed-by: Allan Sandfeld Jensen --- src/corelib/kernel/qpointer.cpp | 58 ++++++++++++++--------------------- src/corelib/tools/qtaggedpointer.qdoc | 2 +- src/corelib/tools/qversionnumber.cpp | 2 +- src/gui/kernel/qcursor.cpp | 6 ++-- src/gui/kernel/qevent.cpp | 2 +- src/gui/kernel/qpalette.cpp | 18 ----------- src/gui/painting/qcolorspace.cpp | 4 +-- src/gui/text/qtextlayout.cpp | 6 ++-- 8 files changed, 32 insertions(+), 66 deletions(-) (limited to 'src') diff --git a/src/corelib/kernel/qpointer.cpp b/src/corelib/kernel/qpointer.cpp index 5f6826b269..737d73c4b8 100644 --- a/src/corelib/kernel/qpointer.cpp +++ b/src/corelib/kernel/qpointer.cpp @@ -201,8 +201,7 @@ */ /*! - \fn template bool operator==(const T *o, const QPointer &p) - \relates QPointer + \fn template bool QPointer::operator==(X *o, const QPointer &p) Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise @@ -210,8 +209,7 @@ */ /*! - \fn template bool operator==(const QPointer &p, const T *o) - \relates QPointer + \fn template bool QPointer::operator==(const QPointer &p, X *o) Equality operator. Returns \c true if \a o and the guarded pointer \a p are pointing to the same object, otherwise @@ -219,74 +217,64 @@ */ /*! - \fn template bool operator==(T *o, const QPointer &p) - \relates QPointer + \fn template bool QPointer::operator==(const QPointer &p1, const QPointer &p2) - Equality operator. Returns \c true if \a o and the guarded - pointer \a p are pointing to the same object, otherwise + Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2 + are pointing to the same object, otherwise returns \c false. */ /*! - \fn template bool operator==(const QPointer &p, T *o) - \relates QPointer + \fn template bool QPointer::operator==(std::nullptr_t, const QPointer &rhs) - Equality operator. Returns \c true if \a o and the guarded - pointer \a p are pointing to the same object, otherwise + Equality operator. Returns \c true if the pointer guarded by \a rhs + is \nullptr, otherwise returns \c false. - */ /*! - \fn template bool operator==(const QPointer &p1, const QPointer &p2) - \relates QPointer + \fn template bool QPointer::operator==(const QPointer &lhs, std::nullptr_t) - Equality operator. Returns \c true if the guarded pointers \a p1 and \a p2 - are pointing to the same object, otherwise + Equality operator. Returns \c true if the pointer guarded by \a lhs + is \nullptr, otherwise returns \c false. - */ - /*! - \fn template bool operator!=(const T *o, const QPointer &p) - \relates QPointer + \fn template bool QPointer::operator!=(const QPointer &p, X *o) Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise returns \c false. */ /*! - \fn template bool operator!=(const QPointer &p, const T *o) - \relates QPointer + \fn template bool QPointer::operator!=(X *o, const QPointer &p) Inequality operator. Returns \c true if \a o and the guarded pointer \a p are not pointing to the same object, otherwise returns \c false. */ /*! - \fn template bool operator!=(T *o, const QPointer &p) - \relates QPointer + \fn template bool QPointer::operator!=(const QPointer &p1, const QPointer &p2) - Inequality operator. Returns \c true if \a o and the guarded - pointer \a p are not pointing to the same object, otherwise + Inequality operator. Returns \c true if the guarded pointers \a p1 and + \a p2 are not pointing to the same object, otherwise returns \c false. */ /*! - \fn template bool operator!=(const QPointer &p, T *o) - \relates QPointer + \fn template bool QPointer::operator!=(std::nullptr_t, const QPointer &rhs) - Inequality operator. Returns \c true if \a o and the guarded - pointer \a p are not pointing to the same object, otherwise + Inequality operator. Returns \c true if the pointer guarded by \a rhs is + a valid (ie not \nullptr) pointer, otherwise returns \c false. */ /*! - \fn template bool operator!=(const QPointer &p1, const QPointer &p2) - \relates QPointer + \fn template bool QPointer::operator!=(const QPointer &lhs, std::nullptr_t) - Inequality operator. Returns \c true if the guarded pointers \a p1 and - \a p2 are not pointing to the same object, otherwise + Inequality operator. Returns \c true if the pointer guarded by \a lhs is + a valid (ie not \nullptr) pointer, otherwise returns \c false. */ + /*! \fn template QPointer qPointerFromVariant(const QVariant &variant) diff --git a/src/corelib/tools/qtaggedpointer.qdoc b/src/corelib/tools/qtaggedpointer.qdoc index 27927cff3d..36e20ecff0 100644 --- a/src/corelib/tools/qtaggedpointer.qdoc +++ b/src/corelib/tools/qtaggedpointer.qdoc @@ -153,7 +153,7 @@ */ /*! - \fn template Tag QTaggedPointer::pointer() const noexcept + \fn template T *QTaggedPointer::data() const noexcept Returns the pointer stored in the tagged pointer. */ diff --git a/src/corelib/tools/qversionnumber.cpp b/src/corelib/tools/qversionnumber.cpp index f91fa20043..f278243cc9 100644 --- a/src/corelib/tools/qversionnumber.cpp +++ b/src/corelib/tools/qversionnumber.cpp @@ -578,7 +578,7 @@ size_t qHash(const QVersionNumber &key, size_t seed) \fn template static bool QTypeRevision::isValidSegment(Integer segment) Returns true if the given number can be used as either major or minor - version in a QTypeRevision. Valid segments need to be \c {>= 0} and \c {< 255}. + version in a QTypeRevision. The valid range for \a segment is \c {>= 0} and \c {< 255}. */ /*! diff --git a/src/gui/kernel/qcursor.cpp b/src/gui/kernel/qcursor.cpp index 9e97470dfb..e70f6ac79b 100644 --- a/src/gui/kernel/qcursor.cpp +++ b/src/gui/kernel/qcursor.cpp @@ -480,8 +480,7 @@ QCursor::QCursor(Qt::CursorShape shape) } /*! - \fn bool operator==(const QCursor &lhs, const QCursor &rhs) - \relates QCursor + \fn bool QCursor::operator==(const QCursor &lhs, const QCursor &rhs) \since 5.10 Equality operator. Returns \c true if \a lhs and \a rhs @@ -519,8 +518,7 @@ bool operator==(const QCursor &lhs, const QCursor &rhs) noexcept } /*! - \fn bool operator!=(const QCursor &lhs, const QCursor &rhs) - \relates QCursor + \fn bool QCursor::operator!=(const QCursor &lhs, const QCursor &rhs) \since 5.10 Inequality operator. Returns the equivalent of !(\a lhs == \a rhs). diff --git a/src/gui/kernel/qevent.cpp b/src/gui/kernel/qevent.cpp index 5938942399..b60672ce17 100644 --- a/src/gui/kernel/qevent.cpp +++ b/src/gui/kernel/qevent.cpp @@ -274,7 +274,7 @@ QEventPoint &QEventPoint::operator=(const QEventPoint &other) */ /*! - \fn QEventPoint &QEventPoint QEventPoint::operator=(QEventPoint &&other) noexcept + \fn QEventPoint &QEventPoint::operator=(QEventPoint &&other) noexcept Move-assigns \a other to this event point instance. */ diff --git a/src/gui/kernel/qpalette.cpp b/src/gui/kernel/qpalette.cpp index da418c7eed..f5d010aa26 100644 --- a/src/gui/kernel/qpalette.cpp +++ b/src/gui/kernel/qpalette.cpp @@ -157,13 +157,6 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) \sa brush(), setColor(), ColorRole */ -/*! - \fn const QBrush & QPalette::foreground() const - \obsolete - - Use windowText() instead. -*/ - /*! \fn const QBrush & QPalette::windowText() const @@ -279,13 +272,6 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) \sa ColorRole, brush() */ -/*! - \fn const QBrush & QPalette::background() const - \obsolete - - Use window() instead. -*/ - /*! \fn const QBrush & QPalette::window() const @@ -451,12 +437,8 @@ static void qt_palette_from_color(QPalette &pal, const QColor &button) \value Window A general background color. - \value Background This value is obsolete. Use Window instead. - \value WindowText A general foreground color. - \value Foreground This value is obsolete. Use WindowText instead. - \value Base Used mostly as the background color for text entry widgets, but can also be used for other painting - such as the background of combobox drop down lists and toolbar handles. diff --git a/src/gui/painting/qcolorspace.cpp b/src/gui/painting/qcolorspace.cpp index a4ae294793..82aec1e50f 100644 --- a/src/gui/painting/qcolorspace.cpp +++ b/src/gui/painting/qcolorspace.cpp @@ -691,6 +691,7 @@ bool QColorSpace::isValid() const noexcept } /*! + \fn bool QColorSpace::operator==(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2) \relates QColorSpace Returns \c true if colorspace \a colorSpace1 is equal to colorspace \a colorSpace2; otherwise returns \c false @@ -742,8 +743,7 @@ bool operator==(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2) } /*! - \fn bool operator!=(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2) - \relates QColorSpace + \fn bool QColorSpace::operator!=(const QColorSpace &colorSpace1, const QColorSpace &colorSpace2) Returns \c true if colorspace \a colorSpace1 is not equal to colorspace \a colorSpace2; otherwise returns \c false diff --git a/src/gui/text/qtextlayout.cpp b/src/gui/text/qtextlayout.cpp index bec1f4a542..6c18c53bca 100644 --- a/src/gui/text/qtextlayout.cpp +++ b/src/gui/text/qtextlayout.cpp @@ -93,15 +93,13 @@ QT_BEGIN_NAMESPACE Specifies the format to apply. */ -/*! \fn bool operator==(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs) - \relates QTextLayout::FormatRange +/*! \fn bool QTextLayout::FormatRange::operator==(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs) Returns true if the \c {start}, \c {length}, and \c {format} fields in \a lhs and \a rhs contain the same values respectively. */ -/*! \fn bool operator!=(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs) - \relates QTextLayout::FormatRange +/*! \fn bool QTextLayout::FormatRange::operator!=(const QTextLayout::FormatRange &lhs, const QTextLayout::FormatRange &rhs) Returns true if any of the \c {start}, \c {length}, or \c {format} fields in \a lhs and \a rhs contain different values respectively. -- cgit v1.2.3