Elementary: documenting elm_all_flush.

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@62319 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/lib/Elementary.h.in b/src/lib/Elementary.h.in
index d1b90c7..d278645 100644 (file)
--- a/src/lib/Elementary.h.in
+++ b/src/lib/Elementary.h.in
@@ -1075,8 +1075,18 @@ extern "C" {
     */
 
    /**
     */
 
    /**

-    * Flush all caches & dump all data that can be to lean down to use
-    * less memory
+    * @brief Flush all caches. 
+    *
+    * Frees all data that was in cache and is not currently being used to reduce
+    * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
+    * to calling all of the following functions:
+    * @li edje_file_cache_flush()
+    * @li edje_collection_cache_flush()
+    * @li eet_clearcache()
+    * @li evas_image_cache_flush()
+    * @li evas_font_cache_flush()
+    * @li evas_render_dump()
+    * @note Evas caches are flushed for every canvas associated with a window.

     *
     * @ingroup Caches
     */
     *
     * @ingroup Caches
     */