diff options
Diffstat (limited to 'src/corelib/global/qminmax.qdoc')
-rw-r--r-- | src/corelib/global/qminmax.qdoc | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/src/corelib/global/qminmax.qdoc b/src/corelib/global/qminmax.qdoc new file mode 100644 index 0000000000..36f680b4c7 --- /dev/null +++ b/src/corelib/global/qminmax.qdoc @@ -0,0 +1,39 @@ +// Copyright (C) 2022 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! \fn template <typename T> const T &qMin(const T &a, const T &b) + \relates <QtMinMax> + + Returns the minimum of \a a and \a b. + + Example: + + \snippet code/src_corelib_global_qglobal.cpp 13 + + \sa qMax(), qBound() +*/ + +/*! \fn template <typename T> const T &qMax(const T &a, const T &b) + \relates <QtMinMax> + + Returns the maximum of \a a and \a b. + + Example: + + \snippet code/src_corelib_global_qglobal.cpp 14 + + \sa qMin(), qBound() +*/ + +/*! \fn template <typename T> const T &qBound(const T &min, const T &val, const T &max) + \relates <QtMinMax> + + Returns \a val bounded by \a min and \a max. This is equivalent + to qMax(\a min, qMin(\a val, \a max)). + + Example: + + \snippet code/src_corelib_global_qglobal.cpp 15 + + \sa qMin(), qMax() +*/ |