From 8534e976436b076568675d6d010a1926dcb996e0 Mon Sep 17 00:00:00 2001
From: Giovanni La Mura <giovanni.lamura@inaf.it>
Date: Tue, 11 Feb 2025 17:40:16 +0100
Subject: [PATCH] Add missing inline documentation tags

---
 src/cluster/cluster.cpp   |  2 +-
 src/include/algebraic.h   |  5 +++--
 src/include/magma_calls.h | 13 ++++++++++---
 3 files changed, 14 insertions(+), 6 deletions(-)

diff --git a/src/cluster/cluster.cpp b/src/cluster/cluster.cpp
index ae4fae9f..baef86e4 100644
--- a/src/cluster/cluster.cpp
+++ b/src/cluster/cluster.cpp
@@ -112,7 +112,7 @@ using namespace std;
  *  \param gconf: `GeometryConfiguration *` Pointer to a `GeometryConfiguration` object.
  *  \param sa: `ScatteringAngles *` Pointer to a `ScatteringAngles` object.
  *  \param cid: `ClusterIterationData *` Pointer to a `ClusterIterationData` object.
- *  \param output: `ClusterOutputInfo *` Pointer to a `ClusterOutputInfo` object.
+ *  \param oi: `ClusterOutputInfo *` Pointer to a `ClusterOutputInfo` object.
  *  \param output_path: `const string &` Path to the output directory.
  *  \param vtppoanp: `VirtualBinaryFile *` Pointer to a `VirtualBinaryFile` object.
  */
diff --git a/src/include/algebraic.h b/src/include/algebraic.h
index d19db956..c59dbae2 100644
--- a/src/include/algebraic.h
+++ b/src/include/algebraic.h
@@ -39,8 +39,9 @@ using namespace std;
  * \param maxrefiters: `int &` Reference to the maximum number of refinement iterations.
  * \param accuracygoal: `double &` Reference to the requested accuracy level.
  * \param refinemode: `int` Flag for refinement mode selection.
- * \param max_size: `np_int` The maximum expected size (required by some call-backs,
- * optional, defaults to 0).
+ * \param output_path: `const string &` Path where the output needs to be placed.
+ * \param jxi488: `int` Index of the current wavelength calculation.
+ * \param max_size: `np_int` The maximum expected size (required by some call-backs, optional, defaults to 0).
  * \param target_device: `int` ID of target GPU, if available (defaults to 0).
  */
 void invert_matrix(dcomplex **mat, np_int size, int &ier, int &maxrefiters, double &accuracygoal, int refinemode, const string& output_path, int jxi488, np_int max_size=0, int target_device=0);
diff --git a/src/include/magma_calls.h b/src/include/magma_calls.h
index 32052810..679b07f3 100644
--- a/src/include/magma_calls.h
+++ b/src/include/magma_calls.h
@@ -59,20 +59,27 @@ void magma_zinvert1(dcomplex * &inva, np_int n, int &jer, int device_id);
  * \param accuracygoal: `double &` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy.
  * \param refinemode: `int` Flag to control the refinement mode.
  * \param device_id: `int` ID of the device for matrix inversion offloading.
+ * \param output_path: `const string &` Path where the output needs to be placed.
+ * \param jxi488: `int` Index of the current wavelength calculation.
  */
 void magma_zinvert_and_refine(dcomplex **mat, np_int n, int &jer, int &maxrefiters, double &accuracygoal, int refinemode, int device_id, const string& output_path, int jxi488);
 
-/*! \brief apply iterative refinement of the solution of a matrix inversion
+/*! \brief Apply iterative refinement of the solution of a matrix inversion.
  *
- * iteratively compute and apply a correction to the inverse inva of the complex matrix aorig, for a maximum number of maxiters times, or until achieving a maximum residual better than accuracygoal
+ * Iteratively compute and apply a correction to the inverse `inva` of the complex
+ * matrix `aorig`, for a maximum number of `maxiters` times, or until achieving a
+ * maximum residual better than `accuracygoal`.
  *
  * \param aorig: pointer to the first element of the matrix of complex to be inverted.
  * \param inva: pointer to the first element of inverse.
  * \param n: `np_int` The number of rows and columns of the [n x n] matrices.
  * \param jer: `int &` Reference to an integer return flag.
  * \param maxrefiters: `int` Maximum number of refinement iterations to apply.
- * \param accuracygoal: `double` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy
+ * \param accuracygoal: `double` Accuracy to achieve in iterative refinement, defined as the module of the maximum difference between the identity matrix and the matrix product of the (approximate) inverse times the original matrix. On return, it contains the actually achieved accuracy.
+ * \param refinemode: `int` Flag for refinement mode selection.
  * \param device_id: `int` ID of the device for matrix inversion offloading.
+ * \param output_path: `const string &` Path where the output needs to be placed.
+ * \param jxi488: `int` Index of the current wavelength calculation.
  */
 void magma_refine(dcomplex *aorig, dcomplex *inva, np_int n, int &jer, int &maxrefiters, double &accuracygoal, int refinemode, int device_id, const string& output_path, int jxi488);
 
-- 
GitLab