libweston: Fix/clean-up doxygen warnings
This fixes warnings for weston-debug, input, compositor, log and
linux-explicit-sync. Warnings range from swapping '[in]', '[out]' with
the function arguments to wrong parameter names.
Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
diff --git a/libweston/compositor.c b/libweston/compositor.c
index fa2645f..2e72513 100644
--- a/libweston/compositor.c
+++ b/libweston/compositor.c
@@ -890,8 +890,8 @@
*
* \param surface The surface to fetch wp_viewport and buffer transformation
* from.
- * \param surface_region[in] The region in surface coordinates.
- * \param buffer_region[out] The region converted to buffer coordinates.
+ * \param[in] surface_region The region in surface coordinates.
+ * \param[out] buffer_region The region converted to buffer coordinates.
*
* Buffer_region must be init'd, but will be completely overwritten.
*
@@ -899,6 +899,7 @@
* and rotations in 90-degree steps. Therefore the only loss in the
* conversion is from the coordinate rounding that takes place in
* \ref weston_surface_to_buffer_rect.
+ *
*/
WL_EXPORT void
weston_surface_to_buffer_region(struct weston_surface *surface,
@@ -971,7 +972,7 @@
* \param surface The surface.
* \param head A head of the entered/left output.
* \param enter True if entered.
- * \param left True if left.
+ * \param leave True if left.
*
* Send the enter/leave events for all protocol objects bound to the given
* output by the client owning the surface.
@@ -4789,7 +4790,7 @@
* \param compositor The compositor.
* \param listener The listener to add.
*
- * The listener notify function argument is the \var compositor.
+ * The listener notify function argument is weston_compositor.
*
* The listener function will be called after heads are added or their
* connection status has changed. Several changes may be accumulated into a
@@ -4810,7 +4811,7 @@
/** Iterate over available heads
*
* \param compositor The compositor.
- * \param item The iterator, or NULL for start.
+ * \param iter The iterator, or NULL for start.
* \return The next available head in the list.
*
* Returns all available heads, regardless of being connected or enabled.
@@ -4856,7 +4857,7 @@
/** Iterate over attached heads
*
* \param output The output whose heads to iterate.
- * \param item The iterator, or NULL for start.
+ * \param iter The iterator, or NULL for start.
* \return The next attached head in the list.
*
* Returns all heads currently attached to the output.
@@ -5564,14 +5565,15 @@
/** Transform device coordinates into global coordinates
*
- * \param device_x[in] X coordinate in device units.
- * \param device_y[in] Y coordinate in device units.
- * \param x[out] X coordinate in the global space.
- * \param y[out] Y coordinate in the global space.
+ * \param output the weston_output object
+ * \param[in] device_x X coordinate in device units.
+ * \param[in] device_y Y coordinate in device units.
+ * \param[out] x X coordinate in the global space.
+ * \param[out] y Y coordinate in the global space.
*
- * Transforms coordinates from the device coordinate space
- * (physical pixel units) to the global coordinate space (logical pixel units).
- * This takes into account output transform and scale.
+ * Transforms coordinates from the device coordinate space (physical pixel
+ * units) to the global coordinate space (logical pixel units). This takes
+ * into account output transform and scale.
*
* \memberof weston_output
* \internal
@@ -6782,7 +6784,7 @@
*
* \param display The Wayland display to be used.
* \param user_data A pointer to an object that can later be retrieved
- * \param wdc A pointer to weston_debug_compositor
+ * \param log_ctx A pointer to weston_debug_compositor
* using the \ref weston_compositor_get_user_data function.
* \return The compositor instance on success or NULL on failure.
*/
@@ -6999,7 +7001,7 @@
/** Read the current time from the Presentation clock
*
* \param compositor
- * \param ts[out] The current time.
+ * \param[out] ts The current time.
*
* \note Reading the current time in user space is always imprecise to some
* degree.