From 48392643ec0ba66267bac199227522185fc6cd41 Mon Sep 17 00:00:00 2001 From: Marius Vlad Date: Fri, 14 Jun 2019 13:04:52 +0300 Subject: [PATCH] clients: Fix/resolved doxygen warnings Missing/wrong parameters and '[out]' issues. Signed-off-by: Marius Vlad --- clients/eventdemo.c | 7 ++++--- clients/touch-calibrator.c | 4 ++-- shared/file-util.c | 2 +- shared/helpers.h | 2 +- 4 files changed, 8 insertions(+), 7 deletions(-) diff --git a/clients/eventdemo.c b/clients/eventdemo.c index 57b67be7..9193bf1b 100644 --- a/clients/eventdemo.c +++ b/clients/eventdemo.c @@ -193,10 +193,11 @@ keyboard_focus_handler(struct window *window, /** * \brief CALLBACK function, Wayland informs about key event * \param window window + * \param input input + * \param time time * \param key keycode * \param unicode associated character * \param state pressed or released - * \param modifiers modifiers: ctrl, alt, meta etc. * \param data user data associated to the window */ static void @@ -351,8 +352,8 @@ axis_discrete_handler(struct widget *widget, struct input *input, * \param time time the event happened * \param x absolute x position * \param y absolute y position - * \param sx x position relative to the window - * \param sy y position relative to the window + * \param x x position relative to the window + * \param y y position relative to the window * \param data user data associated to the window * * Demonstrates the use of different cursors diff --git a/clients/touch-calibrator.c b/clients/touch-calibrator.c index 96f8c5a5..66208d16 100644 --- a/clients/touch-calibrator.c +++ b/clients/touch-calibrator.c @@ -108,8 +108,8 @@ struct poly { * cancel, multiple touch-downs) needs to undo the current sample and * possibly show user feedback "wrong". * - * - * - : + * \ + * - \: \ * * IDLE * - touch down: sample, -> DOWN diff --git a/shared/file-util.c b/shared/file-util.c index fcc4c3f4..151ef2a5 100644 --- a/shared/file-util.c +++ b/shared/file-util.c @@ -69,7 +69,7 @@ create_file_excl(const char *fname) * \param path File path * \param prefix File name prefix. * \param suffix File name suffix. - * \param name_out[out] Buffer for the resulting file name. + * \param[out] name_out Buffer for the resulting file name. * \param name_len Number of bytes usable in name_out. * \return stdio FILE pointer, or NULL on failure. * diff --git a/shared/helpers.h b/shared/helpers.h index 0ebcc4a4..adb68893 100644 --- a/shared/helpers.h +++ b/shared/helpers.h @@ -123,7 +123,7 @@ extern "C" { * expanded[i] = small[4]; * @endcode * - * @param condition Expression to check for truth + * @param cond Expression to check for truth * @param msg Message to print on failure */ #ifndef static_assert