From ec9d9586fc199ea7b5f6cef0f0dbbe7025d62c26 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@qt.io>
Date: Tue, 23 May 2023 16:49:20 +0200
Subject: [PATCH] Doc: Add \a commands and document Utils::MathUtils namespace

Fixes qdoc warnings.

Change-Id: I666e6db9ee3a3a5c83f093f2e48981701f137d5c
Reviewed-by: Jarek Kobus <jaroslaw.kobus@qt.io>
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
---
 src/libs/utils/mathutils.cpp | 34 ++++++++++++++++++++++++++--------
 1 file changed, 26 insertions(+), 8 deletions(-)

diff --git a/src/libs/utils/mathutils.cpp b/src/libs/utils/mathutils.cpp
index 77d9d5e5b27..a25f4515b0b 100644
--- a/src/libs/utils/mathutils.cpp
+++ b/src/libs/utils/mathutils.cpp
@@ -5,12 +5,22 @@
 
 #include <QtMath>
 
+/*!
+    \namespace Utils::MathUtils
+    \inmodule QtCreator
+
+    \brief Contains functions for interpolation.
+*/
+
 namespace Utils::MathUtils {
 
 /*!
     Linear interpolation:
-    For x = x1 it returns y1.
-    For x = x2 it returns y2.
+
+    \list
+        \li For \a x = \a x1 it returns \a y1.
+        \li For \a x = \a x2 it returns \a y2.
+    \endlist
 */
 int interpolateLinear(int x, int x1, int x2, int y1, int y2)
 {
@@ -29,9 +39,13 @@ int interpolateLinear(int x, int x1, int x2, int y1, int y2)
 
 /*!
     Tangential interpolation:
-    For x = 0 it returns y1.
-    For x = xHalfLife it returns 50 % of the distance between y1 and y2.
-    For x = infinity it returns y2.
+
+    \list
+        \li For \a x = 0 it returns \a y1.
+        \li For \a x = \a xHalfLife it returns 50 % of the distance between
+            \a y1 and \a y2.
+        \li For \a x = infinity it returns \a y2.
+    \endlist
 */
 int interpolateTangential(int x, int xHalfLife, int y1, int y2)
 {
@@ -46,9 +60,13 @@ int interpolateTangential(int x, int xHalfLife, int y1, int y2)
 
 /*!
     Exponential interpolation:
-    For x = 0 it returns y1.
-    For x = xHalfLife it returns 50 % of the distance between y1 and y2.
-    For x = infinity it returns y2.
+
+    \list
+        \li For \a x = 0 it returns \a y1.
+        \li For \a x = \a xHalfLife it returns 50 % of the distance between
+            \a y1 and \a y2.
+        \li For \a x = infinity it returns \a y2.
+    \endlist
 */
 int interpolateExponential(int x, int xHalfLife, int y1, int y2)
 {