summaryrefslogtreecommitdiff
path: root/src/lib/ecore_evas
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2020-04-27 10:01:09 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2020-04-27 10:01:09 +0200
commit4cf59afcc96e7977d8039be289d42e587c607c0e (patch)
treebe658e3531d9b388fbd974e15d600414b4a37af3 /src/lib/ecore_evas
parentcd7b594466e3e9c470541b5f61069eb683e0729b (diff)
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.
Diffstat (limited to 'src/lib/ecore_evas')
-rw-r--r--src/lib/ecore_evas/Ecore_Evas.h10
1 files changed, 4 insertions, 6 deletions
diff --git a/src/lib/ecore_evas/Ecore_Evas.h b/src/lib/ecore_evas/Ecore_Evas.h
index 054fa79f1a..b8d2a878dd 100644
--- a/src/lib/ecore_evas/Ecore_Evas.h
+++ b/src/lib/ecore_evas/Ecore_Evas.h
@@ -202,7 +202,7 @@ EAPI int ecore_evas_shutdown(void);
202 * Turns on client+server synchronized rendering in X11. App comp sync 202 * Turns on client+server synchronized rendering in X11. App comp sync
203 * is disabled by default, but can be turned on optionally. 203 * is disabled by default, but can be turned on optionally.
204 * 204 *
205 * @note This is an experimental functionality and is likely to be removed. 205 * @warning This is a deprecated API. DO NOT USE.
206 * 206 *
207 * @param do_sync True to enable comp syncing, False to disable 207 * @param do_sync True to enable comp syncing, False to disable
208 */ 208 */
@@ -213,7 +213,7 @@ EAPI void ecore_evas_app_comp_sync_set(Eina_Bool do_sync);
213 * 213 *
214 * @return True if app comp sync is enabled. 214 * @return True if app comp sync is enabled.
215 * 215 *
216 * @note This is an experimental functionality and is likely to be removed. 216 * @warning This is a deprecated API. DO NOT USE.
217 * 217 *
218 */ 218 */
219EAPI Eina_Bool ecore_evas_app_comp_sync_get(void); 219EAPI Eina_Bool ecore_evas_app_comp_sync_get(void);
@@ -2891,8 +2891,7 @@ EAPI void ecore_evas_manual_render(Ecore_Evas *ee);
2891 * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC 2891 * set via the ECORE_EVAS_COMP_NOSYNC / ECORE_EVAS_COMP_SYNC
2892 * environmental variables. 2892 * environmental variables.
2893 * 2893 *
2894 * @note This is an experimental functionality and is likely to be 2894 * @warning This is a deprecated API. DO NOT USE.
2895 * removed in future versions of EFL.
2896 */ 2895 */
2897EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync); 2896EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
2898 2897
@@ -2902,8 +2901,7 @@ EAPI void ecore_evas_comp_sync_set(Ecore_Evas *ee, Eina_Bool do_sync);
2902 * @param ee An @c Ecore_Evas handle 2901 * @param ee An @c Ecore_Evas handle
2903 * @return True if composition synchronization is enabled, False otherwise 2902 * @return True if composition synchronization is enabled, False otherwise
2904 * 2903 *
2905 * @note This is an experimental functionality and is likely to be 2904 * @warning This is a deprecated API. DO NOT USE.
2906 * removed in future versions of EFL.
2907 */ 2905 */
2908EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee); 2906EAPI Eina_Bool ecore_evas_comp_sync_get(const Ecore_Evas *ee);
2909 2907