doxygen docs: Fix warnings in Ecore_Wl2.h and associates
authorXavi Artigas <xavierartigas@yahoo.es>
Tue, 24 Mar 2020 12:42:08 +0000 (13:42 +0100)
committerJongmin Lee <jm105.lee@samsung.com>
Tue, 24 Mar 2020 21:54:56 +0000 (06:54 +0900)
src/lib/ecore_wl2/Ecore_Wl2.h
src/lib/ecore_wl2/ecore_wl2_internal.h

index 29b9d318af3163be88c9c3b26f0b365cbd53221c..f2890aa67f5a892387d4b1acf637e2deea924011 100644 (file)
@@ -1508,9 +1508,9 @@ EAPI void ecore_wl2_window_commit(Ecore_Wl2_Window *window, Eina_Bool flush);
 EAPI Ecore_Wl2_Frame_Cb_Handle *ecore_wl2_window_frame_callback_add(Ecore_Wl2_Window *window, Ecore_Wl2_Frame_Cb cb, void *data);
 
 /**
- * @brief delete a callback that fires when the window's surface_frame callback fires
+ * @brief Delete a callback that fires when the window's surface_frame callback fires
  *
- * @param cb The callback handle
+ * @param handle The callback handle obtained through ecore_wl2_window_frame_callback_add().
  *
  * @ingroup Ecore_Wl2_Window_Group
  * @since 1.21
@@ -1800,7 +1800,7 @@ EAPI Eina_Bool ecore_wl2_window_transparent_get(Ecore_Wl2_Window *window);
  *
  * Set the opaque region of the Ecore_Wl2_Window
  *
- * @param win The window
+ * @param window The window
  * @param x The left point of the region.
  * @param y The top point of the region.
  * @param w The width of the region.
@@ -1825,7 +1825,7 @@ EAPI void ecore_wl2_window_input_rect_subtract(Ecore_Wl2_Window *win, Eina_Recta
  *
  * Get the opaque region of the Ecore_Wl2_Window
  *
- * @param win The window
+ * @param window The window
  * @param x The left point of the region.
  * @param y The top point of the region.
  * @param w The width of the region.
@@ -1919,7 +1919,7 @@ EAPI Eina_Bool ecore_wl2_window_fullscreen_get(Ecore_Wl2_Window *window);
  * Set the fullscreen state of a given window
  *
  * @param window The window to set the fullscreen state of
- * @param maximized EINA_TRUE to set fullscreen, EINA_FALSE to unset
+ * @param fullscreen EINA_TRUE to set fullscreen, EINA_FALSE to unset
  *
  * @ingroup Ecore_Wl2_Window_Group
  * @since 1.17
@@ -2321,7 +2321,7 @@ EAPI Ecore_Wl2_Input *ecore_wl2_window_popup_input_get(Ecore_Wl2_Window *window)
  *
  * Check if a window has a shell surface - without one it can't be visible.
  *
- * @param The window to check
+ * @param win The window to check
  *
  * @return Returns true if the window has an associated shell surface.
  *
@@ -2538,7 +2538,7 @@ EAPI void ecore_wl2_window_sync_geometry_set(Ecore_Wl2_Window *window, uint32_t
 /**
  * Gets default input of a given display
  *
- * @param display The display
+ * @param ewd The display
  *
  * @ingroup Ecore_Wl2_Input_Group
  * @since 1.24
index d9c76368eff90dc9021412bc576e98ce8bca2da0..d0af8bbd67ca879a9469dc9a0e1707331b92c91d 100644 (file)
@@ -220,9 +220,9 @@ EAPI void ecore_wl2_offer_finish(Ecore_Wl2_Offer *offer);
  * Create and return a new subsurface.
  *
  * Create a new surface (and subsurface interface), with the parent surface
- * being the one associated with the given @param win.
+ * being the one associated with the given window.
  *
- * The @param win must be visible, otherwise there will be no surface created
+ * @param window The window. It must be visible, otherwise there will be no surface created
  * for it yet.
  *
  * @return the allocated and initialized Ecore_Wl2_Subsurface object, or
@@ -285,8 +285,8 @@ EAPI void ecore_wl2_subsurface_position_get(Ecore_Wl2_Subsurface *subsurface, in
 /**
  * Place subsurface on layer above a reference surface
  *
- * Moves the @param subsurface to just above the reference @param
- * surface, changing the z-order.  The reference @param surface must
+ * Moves the subsurface to just above the reference surface,
+ * changing the z-order.  The reference surface must
  * be either a sibling or parent surface, else a protocol error will
  * be generated.
  *