diff options
Diffstat (limited to 'src/corelib/kernel/qmath.qdoc')
| -rw-r--r-- | src/corelib/kernel/qmath.qdoc | 40 |
1 files changed, 8 insertions, 32 deletions
diff --git a/src/corelib/kernel/qmath.qdoc b/src/corelib/kernel/qmath.qdoc index 4c07e40765..bc365f26fa 100644 --- a/src/corelib/kernel/qmath.qdoc +++ b/src/corelib/kernel/qmath.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \headerfile <QtMath> @@ -156,7 +132,7 @@ \since 6.1 \overload \fn template <typename Tx, typename Ty> auto qHypot(Tx x, Ty y) - Returns the distance of a point (x, y) from the origin (0, 0). + Returns the distance of a point (\a x, \a y) from the origin (0, 0). This is qSqrt(x * x + y * y), optimized. In particular, underflow and overflow may be avoided. @@ -194,7 +170,7 @@ This is as for the two-argument and three-argument forms, supported by std::hypot(), but with as many numeric parameters as you care to pass to - it. Uses \a first and each of the \a rest as co-ordinates, performing a + it. Uses \a first and each of the \a rest as coordinates, performing a calculation equivalent to squaring each, summing and returning the square root, save that underflow and overflow are avoided as far as possible. @@ -322,7 +298,7 @@ \relates <QtMath> \since 5.4 - This function returns the nearest power of two greater than \a value. For 0 it returns 1, and for values larger than or equal to 2^31 it returns 0. + This function returns the nearest power of two greater than \a value. For 0 it returns 1, and for values larger than or equal to 2^31 the result is undefined. */ /*! @@ -331,7 +307,7 @@ \since 5.4 \overload - This function returns the nearest power of two greater than \a value. For negative values it returns 0. + This function returns the nearest power of two greater than \a value. For negative values the result is undefined. */ /*! @@ -339,7 +315,7 @@ \relates <QtMath> \since 5.4 - This function returns the nearest power of two greater than \a value. For 0 it returns 1, and for values larger than or equal to 2^63 it returns 0. + This function returns the nearest power of two greater than \a value. For 0 it returns 1, and for values larger than or equal to 2^63 the result is undefined. */ /*! @@ -348,5 +324,5 @@ \since 5.4 \overload - This function returns the nearest power of two greater than \a value. For negative values it returns 0. + This function returns the nearest power of two greater than \a value. For negative values the result is undefined. */ |