From 5a91c20bd3e18960afb2710174df358c1a423b09 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Sun, 6 Aug 2023 21:12:41 +0200
Subject: [PATCH] Fix -Wdocumentation warnings
---
test/testautomation_math.c | 36 ++++++++++++++++++------------------
test/testautomation_render.c | 2 +-
2 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/test/testautomation_math.c b/test/testautomation_math.c
index 87637c0..9c05ca5 100644
--- a/test/testautomation_math.c
+++ b/test/testautomation_math.c
@@ -64,10 +64,10 @@ typedef double(SDLCALL *dd_to_d_func)(double, double);
* \brief Runs all the cases on a given function with a signature double -> double.
* The result is expected to be exact.
*
- * \param func_name, a printable name for the tested function.
- * \param func, the function to call.
- * \param cases, an array of all the cases.
- * \param cases_size, the size of the cases array.
+ * \param func_name a printable name for the tested function.
+ * \param func the function to call.
+ * \param cases an array of all the cases.
+ * \param cases_size the size of the cases array.
*/
static int
helper_dtod(const char *func_name, d_to_d_func func,
@@ -90,10 +90,10 @@ helper_dtod(const char *func_name, d_to_d_func func,
* \brief Runs all the cases on a given function with a signature double -> double.
* Checks if the result between expected +/- EPSILON.
*
- * \param func_name, a printable name for the tested function.
- * \param func, the function to call.
- * \param cases, an array of all the cases.
- * \param cases_size, the size of the cases array.
+ * \param func_name a printable name for the tested function.
+ * \param func the function to call.
+ * \param cases an array of all the cases.
+ * \param cases_size the size of the cases array.
*/
static int
helper_dtod_inexact(const char *func_name, d_to_d_func func,
@@ -119,10 +119,10 @@ helper_dtod_inexact(const char *func_name, d_to_d_func func,
* \brief Runs all the cases on a given function with a signature
* (double, double) -> double. The result is expected to be exact.
*
- * \param func_name, a printable name for the tested function.
- * \param func, the function to call.
- * \param cases, an array of all the cases.
- * \param cases_size, the size of the cases array.
+ * \param func_name a printable name for the tested function.
+ * \param func the function to call.
+ * \param cases an array of all the cases.
+ * \param cases_size the size of the cases array.
*/
static int
helper_ddtod(const char *func_name, dd_to_d_func func,
@@ -145,10 +145,10 @@ helper_ddtod(const char *func_name, dd_to_d_func func,
* \brief Runs all the cases on a given function with a signature
* (double, double) -> double. Checks if the result between expected +/- EPSILON.
*
- * \param func_name, a printable name for the tested function.
- * \param func, the function to call.
- * \param cases, an array of all the cases.
- * \param cases_size, the size of the cases array.
+ * \param func_name a printable name for the tested function.
+ * \param func the function to call.
+ * \param cases an array of all the cases.
+ * \param cases_size the size of the cases array.
*/
static int
helper_ddtod_inexact(const char *func_name, dd_to_d_func func,
@@ -176,8 +176,8 @@ helper_ddtod_inexact(const char *func_name, dd_to_d_func func,
* This function is only meant to test functions that returns the input value if it is
* integral: f(x) -> x for x in N.
*
- * \param func_name, a printable name for the tested function.
- * \param func, the function to call.
+ * \param func_name a printable name for the tested function.
+ * \param func the function to call.
*/
static int
helper_range(const char *func_name, d_to_d_func func)
diff --git a/test/testautomation_render.c b/test/testautomation_render.c
index 74b9631..b035244 100644
--- a/test/testautomation_render.c
+++ b/test/testautomation_render.c
@@ -1043,7 +1043,7 @@ _hasTexAlpha(void)
/**
* @brief Compares screen pixels with image pixels. Helper function.
*
- * @param s Image to compare against.
+ * @param referenceSurface Image to compare against.
*
* \sa
* http://wiki.libsdl.org/SDL_RenderReadPixels