Better ecore_evas intro docs.
authorgastal <gastal@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 1 Mar 2012 13:02:17 +0000 (13:02 +0000)
committergastal <gastal@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 1 Mar 2012 13:02:17 +0000 (13:02 +0000)
git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@68572 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

doc/examples.dox
src/lib/ecore/Ecore.h
src/lib/ecore_evas/Ecore_Evas.h

index a3042a9..f9d0861 100644 (file)
  */
 
 /**
- * @page Ecore_Evas_Window_Sizes_Example_c Ecore_Evas window sizes
+ * @page Ecore_Evas_Window_Sizes_Example_c Ecore_Evas window size hints
  *
  * On this example, we show you how to deal with @c Ecore_Evas window
  * size hints, which are implemented <b>per Evas engine</b>.
index 8ab3e71..57411ed 100644 (file)
@@ -22,7 +22,7 @@
    @li @ref Ecore_Main_Loop_Group
    @li @ref Ecore_File_Group
    @li @ref Ecore_Con_Group
-   @li @link Ecore_Evas.h   Ecore_Evas - Evas convenience functions. @endlink
+   @li @ref Ecore_Evas_Group
    @li @ref Ecore_FB_Group
    @li @link Ecore_Ipc.h    Ecore_IPC - Inter Process Communication functions. @endlink
    @li @link Ecore_X.h      Ecore_X - X Windows System wrapper. @endlink
index d595ac4..4ddeaf3 100644 (file)
@@ -39,6 +39,9 @@
  * @li @ref ecore_evas_callbacks_example_c
  * @li @ref ecore_evas_object_example_c
  * @li @ref ecore_evas_basics_example_c
+ * @li @ref Ecore_Evas_Window_Sizes_Example_c
+ * @li @ref Ecore_Evas_Buffer_Example_01_c
+ * @li @ref Ecore_Evas_Buffer_Example_02_c
  */
 
 /* FIXME:
@@ -60,10 +63,26 @@ extern "C" {
 /**
  * @defgroup Ecore_Evas_Group Ecore_Evas wrapper/helper set of functions
  *
+ * Ecore evas is a set functions that make it easy to tie together ecore's main
+ * loop and input handling to evas. As such it's a natural base for EFL
+ * applications. While this combination makes it easy to create the basic
+ * aspects all applications need, for normal applications(ones with buttons,
+ * checkboxes and layouts) one should consider using Elementary.
+ *
+ * Ecore evas is extremely well suited for applications that are not based on
+ * widgets. It has a main loop that delivers events, does basic window handling
+ * and leaves all of the drawing up to the user. This works very well if used
+ * in conjunction with Edje or if doing custom drawing as, for example, is done
+ * in games.
+ *
  * This is a list of examples of these functions:
- * - @ref Ecore_Evas_Window_Sizes_Example_c
- * - @ref Ecore_Evas_Buffer_Example_01_c
- * - @ref Ecore_Evas_Buffer_Example_02_c
+ * @li @ref ecore_evas_basics_example_c
+ * @li @ref ecore_evas_object_example_c
+ * @li @ref ecore_evas_callbacks_example_c
+ * @li @ref Ecore_Evas_Window_Sizes_Example_c
+ * @li @ref Ecore_Evas_Buffer_Example_01_c
+ * @li @ref Ecore_Evas_Buffer_Example_02_c
+ *
  * @{
  */