ecore_wl2: improve document of exported shell

The commit behaviour is synchronized mode by default, so all relevant API
needs parent wl_surface.commit to get applied.
If user change the commit behaviour to desynchronized mode, then it is
necessary to call ecore_wl2_subsurface_exported_surface_commit.

Change-Id: I7b08568b1935079630058039b67adf351ea02925

diff --git a/src/lib/ecore_wl2/Ecore_Wl2.h b/src/lib/ecore_wl2/Ecore_Wl2.h
index f285737..5da0549 100644 (file)
--- a/src/lib/ecore_wl2/Ecore_Wl2.h
+++ b/src/lib/ecore_wl2/Ecore_Wl2.h
@@ -3341,6 +3341,12 @@ EAPI const char* ecore_wl2_subsurface_exported_surface_handle_get(Ecore_Wl2_Subs
  *
  * @param subsurface The subsurface to show exported surface
  *
+ * @note This change won't be applied unless parent wl_surface.commit,
+ *       if commit behaviour is synchronized mode which can be changed
+ *       by ecore_wl2_subsurface_exported_surface_sync_set
+ *
+ * @see ecore_wl2_subsurface_exported_surface_commit
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3351,6 +3357,12 @@ EAPI void ecore_wl2_subsurface_exported_surface_show(Ecore_Wl2_Subsurface *subsu
  *
  * @param subsurface The subsurface to hide exported surface
  *
+ * @note This change won't be applied unless parent wl_surface.commit,
+ *       if commit behaviour is synchronized mode which can be changed
+ *       by ecore_wl2_subsurface_exported_surface_sync_set
+ *
+ * @see ecore_wl2_subsurface_exported_surface_commit
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3363,6 +3375,9 @@ EAPI void ecore_wl2_subsurface_exported_surface_hide(Ecore_Wl2_Subsurface *subsu
  * @param other the sibling reference subsurface, or NULL for parent surface
  * @see ecore_wl2_subsurface_place_surface_above
  *
+ * @note Make sure that parent wl_surface.commit. This change won't be applied
+ *       unless parent wl_surface.commit.
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3375,6 +3390,9 @@ EAPI void ecore_wl2_subsurface_exported_surface_place_above(Ecore_Wl2_Subsurface
  * @param other the sibling reference subsurface, or NULL for parent surface
  * @see ecore_wl2_subsurface_place_surface_above
  *
+ * @note Make sure that parent wl_surface.commit. This change won't be applied
+ *       unless parent wl_surface.commit.
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3387,6 +3405,12 @@ EAPI void ecore_wl2_subsurface_exported_surface_place_below(Ecore_Wl2_Subsurface
  * @param x X position of exported surface
  * @param y Y position of exported surface
  *
+ * @note This change won't be applied unless parent wl_surface.commit,
+ *       if commit behaviour is synchronized mode which can be changed
+ *       by ecore_wl2_subsurface_exported_surface_sync_set
+ *
+ * @see ecore_wl2_subsurface_exported_surface_commit
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3399,6 +3423,12 @@ EAPI void ecore_wl2_subsurface_exported_surface_move(Ecore_Wl2_Subsurface *subsu
  * @param w Width of exported surface
  * @param h Height of exported surface
  *
+ * @note This change won't be applied unless parent wl_surface.commit,
+ *       if commit behaviour is synchronized mode which can be changed
+ *       by ecore_wl2_subsurface_exported_surface_sync_set
+ *
+ * @see ecore_wl2_subsurface_exported_surface_commit
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */
@@ -3417,6 +3447,12 @@ EAPI void ecore_wl2_subsurface_exported_surface_resize(Ecore_Wl2_Subsurface *sub
  *     <li>3 - 270 degrees clockwise (WTZ_EXPORTED_SHELL_TRANSFORM_270)</li>
  * </ul>
  *
+ * @note This change won't be applied unless parent wl_surface.commit,
+ *       if commit behaviour is synchronized mode which can be changed
+ *       by ecore_wl2_subsurface_exported_surface_sync_set
+ *
+ * @see ecore_wl2_subsurface_exported_surface_commit
+ *
  * @ingroup Ecore_Wl2_Subsurface_Group
  * @since_tizen 6.5
  */