From: Xavi Artigas <xavierartigas@yahoo.es>
Date: Mon, 27 Apr 2020 08:01:09 +0000 (+0200)
Subject: doxygen docs: Document compositor sync API as deprecated
X-Git-Tag: accepted/tizen/unified/20200428.214706~7
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d0518baa9b263cf5950942229e49c74899ce185a;p=platform%2Fupstream%2Fefl.git

doxygen docs: Document compositor sync API as deprecated

This is currently a NOP and we should remove this API later on.
Meanwhile, turn the note about this API being experimental into
a deprecation warning.
---

diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index a710ae8..a500494 100755
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -210,7 +210,7 @@ EAPI int         ecore_evas_shutdown(void);
  * Turns on client+server synchronized rendering in X11.  App comp sync
  * is disabled by default, but can be turned on optionally.
  *
- * @note This is an experimental functionality and is likely to be removed.
+ * @warning This is a deprecated API. DO NOT USE.
  *
  * @param do_sync True to enable comp syncing, False to disable
  */
@@ -221,7 +221,7 @@ EAPI void        ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
  *
  * @return True if app comp sync is enabled.
  *
- * @note This is an experimental functionality and is likely to be removed.
+ * @warning This is a deprecated API. DO NOT USE.
  *
  */
 EAPI Eina_Bool   ecore_evas_app_comp_sync_get(void);
@@ -2948,8 +2948,7 @@ EAPI void        ecore_evas_manual_render(Ecore_Evas *ee);
  * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC
  * environmental variables.
  *
- * @note This is an experimental functionality and is likely to be
- * removed in future versions of EFL.
+ * @warning This is a deprecated API. DO NOT USE.
  */
 EAPI void        ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
 
@@ -2959,8 +2958,7 @@ EAPI void        ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
  * @param ee An @c Ecore_Evas handle
  * @return True if composition synchronization is enabled, False otherwise
  *
- * @note This is an experimental functionality and is likely to be
- * removed in future versions of EFL.
+ * @warning This is a deprecated API. DO NOT USE.
  */
 EAPI Eina_Bool   ecore_evas_comp_sync_get(const Ecore_Evas *ee);