Elementary: improving elm engine documentation.

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

diff --git a/src/lib/elm_main.c b/src/lib/elm_main.c
index b2ccb89..2edc54d 100644 (file)
--- a/src/lib/elm_main.c
+++ b/src/lib/elm_main.c
@@ -1269,18 +1269,35 @@ elm_profile_all_set(const char *profile)
  *
  * These are functions setting and querying which rendering engine
  * Elementary will use for drawing its windows' pixels.
+ *
+ * The following are the available engines:
+ * @li "software_x11"
+ * @li "fb"
+ * @li "directfb"
+ * @li "software_16_x11"
+ * @li "software_8_x11"
+ * @li "xrender_x11"
+ * @li "opengl_x11"
+ * @li "software_gdi"
+ * @li "software_16_wince_gdi"
+ * @li "sdl"
+ * @li "software_16_sdl"
+ * @li "opengl_sdl"
+ * @li "buffer"
+ *
+ * @{
  */
 
 /**
- * Get Elementary's rendering engine in use.
- *
- * This gets the global rendering engine that is applied to all
- * Elementary applications.
+ * @brief Get Elementary's rendering engine in use.
  *
  * @return The rendering engine's name
- * @ingroup Engine
- *
  * @note there's no need to free the returned string, here.
+ *
+ * This gets the global rendering engine that is applied to all Elementary
+ * applications.
+ *
+ * @see elm_engine_set()
  */
 EAPI const char *
 elm_engine_current_get(void)
@@ -1289,16 +1306,15 @@ elm_engine_current_get(void)
 }
 
 /**
- * Set Elementary's rendering engine for use.
- *
- * This gets sets global rendering engine that is applied to all
- * Elementary applications. Note that it will take effect only to
- * subsequent Elementary window creations.
+ * @brief Set Elementary's rendering engine for use.
  *
  * @param engine The rendering engine's name
- * @ingroup Engine
  *
- * @note there's no need to free the returned string, here.
+ * This sets global rendering engine that is applied to all Elementary
+ * applications. Note that it will take effect only to Elementary windows
+ * created after this is called.
+ *
+ * @see elm_win_add()
  */
 EAPI void
 elm_engine_set(const char *engine)
@@ -1307,6 +1323,9 @@ elm_engine_set(const char *engine)
 
    _elm_config_engine_set(engine);
 }
+/**
+ * @}
+ */
 
 /**
  * @defgroup Fonts Elementary Fonts