clients: Fix/resolved doxygen warnings

Missing/wrong parameters and '[out]' issues.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
dev
Marius Vlad 5 years ago committed by Pekka Paalanen
parent eeabe17e7c
commit 48392643ec
  1. 7
      clients/eventdemo.c
  2. 4
      clients/touch-calibrator.c
  3. 2
      shared/file-util.c
  4. 2
      shared/helpers.h

@ -193,10 +193,11 @@ keyboard_focus_handler(struct window *window,
/** /**
* \brief CALLBACK function, Wayland informs about key event * \brief CALLBACK function, Wayland informs about key event
* \param window window * \param window window
* \param input input
* \param time time
* \param key keycode * \param key keycode
* \param unicode associated character * \param unicode associated character
* \param state pressed or released * \param state pressed or released
* \param modifiers modifiers: ctrl, alt, meta etc.
* \param data user data associated to the window * \param data user data associated to the window
*/ */
static void static void
@ -351,8 +352,8 @@ axis_discrete_handler(struct widget *widget, struct input *input,
* \param time time the event happened * \param time time the event happened
* \param x absolute x position * \param x absolute x position
* \param y absolute y position * \param y absolute y position
* \param sx x position relative to the window * \param x x position relative to the window
* \param sy y position relative to the window * \param y y position relative to the window
* \param data user data associated to the window * \param data user data associated to the window
* *
* Demonstrates the use of different cursors * Demonstrates the use of different cursors

@ -108,8 +108,8 @@ struct poly {
* cancel, multiple touch-downs) needs to undo the current sample and * cancel, multiple touch-downs) needs to undo the current sample and
* possibly show user feedback "wrong". * possibly show user feedback "wrong".
* *
* <STATE> * \<STATE\>
* - <triggers>: <actions> * - \<triggers\>: \<actions\>
* *
* IDLE * IDLE
* - touch down: sample, -> DOWN * - touch down: sample, -> DOWN

@ -69,7 +69,7 @@ create_file_excl(const char *fname)
* \param path File path * \param path File path
* \param prefix File name prefix. * \param prefix File name prefix.
* \param suffix File name suffix. * \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. * \param name_len Number of bytes usable in name_out.
* \return stdio FILE pointer, or NULL on failure. * \return stdio FILE pointer, or NULL on failure.
* *

@ -123,7 +123,7 @@ extern "C" {
* expanded[i] = small[4]; * expanded[i] = small[4];
* @endcode * @endcode
* *
* @param condition Expression to check for truth * @param cond Expression to check for truth
* @param msg Message to print on failure * @param msg Message to print on failure
*/ */
#ifndef static_assert #ifndef static_assert

Loading…
Cancel
Save