1berry/qtbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doc: Add \relates command for documented global functions/macros

Browse Source 
Global functions need an associated header file/class/namespace to make
the documentation visible.

Remove QDoc comment tag (/*!) for an internal function.

Pick-to: 6.3
Task-number: QTBUG-99578
Change-Id: Id390d433d7e081fc90fa57a02097b6c37fa13bee
Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
This commit is contained in:
Topi Reinio 2022-03-23 22:59:38 +01:00
parent b34ed061e3
commit 62a26df2ff
5 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/corelib/global/qnumeric.cpp
View File

@ -256,6 +256,7 @@ Q_CORE_EXPORT quint64 qFloatDistance(double a, double b)
/*! /*!
\fn template<typename T> bool qAddOverflow(T v1, T v2, T *result) \fn template<typename T> bool qAddOverflow(T v1, T v2, T *result)
\relates <QtGlobal>
\since 6.1 \since 6.1
Adds two values \a v1 and \a v2, of a numeric type \c T and records the Adds two values \a v1 and \a v2, of a numeric type \c T and records the
@ -287,6 +288,7 @@ Q_CORE_EXPORT quint64 qFloatDistance(double a, double b)
/*! /*!
\fn template<typename T> bool qSubOverflow(T v1, T v2, T *result) \fn template<typename T> bool qSubOverflow(T v1, T v2, T *result)
\relates <QtGlobal>
\since 6.1 \since 6.1
Subtracts \a v2 from \a v1 and records the resulting value in \a result. If Subtracts \a v2 from \a v1 and records the resulting value in \a result. If
@ -318,6 +320,7 @@ Q_CORE_EXPORT quint64 qFloatDistance(double a, double b)
/*! /*!
\fn template<typename T> bool qMulOverflow(T v1, T v2, T *result) \fn template<typename T> bool qMulOverflow(T v1, T v2, T *result)
\relates <QtGlobal>
\since 6.1 \since 6.1
Multiplies \a v1 and \a v2, and records the resulting value in \a result. If Multiplies \a v1 and \a v2, and records the resulting value in \a result. If

2
src/corelib/kernel/qmetatype.cpp
View File

@ -2657,7 +2657,7 @@ static inline int qMetaTypeTypeImpl(const char *typeName, int length)
*/ */
/*! /*!
\a internal \internal
Similar to QMetaType::type(); the only difference is that this function Similar to QMetaType::type(); the only difference is that this function
doesn't attempt to normalize the type name (i.e., the lookup will fail doesn't attempt to normalize the type name (i.e., the lookup will fail

1
src/testlib/qtestcase.qdoc
View File

@ -163,6 +163,7 @@
/*! /*!
\macro QVERIFY_THROWS_EXCEPTION(exceptiontype, ...) \macro QVERIFY_THROWS_EXCEPTION(exceptiontype, ...)
\relates QTest
\since 6.3 \since 6.3
The QVERIFY_THROWS_EXCEPTION macro executes the expression given in the variadic The QVERIFY_THROWS_EXCEPTION macro executes the expression given in the variadic

2
src/widgets/styles/qdrawutil.cpp
View File

@ -799,6 +799,7 @@ void qDrawWinButton(QPainter *p, const QRect &r,
/*! /*!
\fn void qDrawWinPanel(QPainter *painter, const QRect &rect, const QPalette &palette, \fn void qDrawWinPanel(QPainter *painter, const QRect &rect, const QPalette &palette,
bool sunken, const QBrush *fill) bool sunken, const QBrush *fill)
\relates <qdrawutil.h>
\overload \overload
Draws the Windows-style panel at the rectangle specified by \a rect using Draws the Windows-style panel at the rectangle specified by \a rect using
@ -895,6 +896,7 @@ void qDrawPlainRect(QPainter *p, const QRect &r, const QColor &c,
typedef QVarLengthArray<QPainter::PixmapFragment, 16> QPixmapFragmentsArray; typedef QVarLengthArray<QPainter::PixmapFragment, 16> QPixmapFragmentsArray;
/*! /*!
\relates <qdrawutil.h>
\since 4.6 \since 4.6
Draws the indicated \a sourceRect rectangle from the given \a pixmap into Draws the indicated \a sourceRect rectangle from the given \a pixmap into

4
src/widgets/widgets/qeffects.cpp
View File

@ -553,7 +553,7 @@ void QRollEffect::scroll()
} }
} }
/*! /*
Scroll widget \a w in \a time ms. \a orient may be 1 (vertical), 2 Scroll widget \a w in \a time ms. \a orient may be 1 (vertical), 2
(horizontal) or 3 (diagonal). (horizontal) or 3 (diagonal).
*/ */
@ -576,7 +576,7 @@ void qScrollEffect(QWidget* w, QEffects::DirFlags orient, int time)
q_roll->run(time); q_roll->run(time);
} }
/*! /*
Fade in widget \a w in \a time ms. Fade in widget \a w in \a time ms.
*/ */
void qFadeEffect(QWidget* w, int time) void qFadeEffect(QWidget* w, int time)