fix a bit the documentation

git-svn-id: http://svn.enlightenment.org/svn/e/trunk/eina@41870 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/src/include/Eina.h b/src/include/Eina.h
index d953d50..84d6341 100644 (file)
--- a/src/include/Eina.h
+++ b/src/include/Eina.h
@@ -22,6 +22,7 @@
 /**
  * @mainpage Eina
  * @author Jorge Luis Zapata Muga
+ * @author Cedric Bail
  * @date 2008
  *
  * @section eina_toc_sec Table of contents
@@ -52,6 +53,8 @@
  *     <li> @ref eina_counter_subsec
  *     <li> @ref eina_error_subsec
  *   </ul>
+ *   <li> @ref thread_safety_sec
+ *   <li> @ref debugging_sec
  * </ul>
  *
  * @section eina_intro_sec Introduction
@@ -132,6 +135,14 @@
  *
  * Take a look at the @ref tutorial_error_page.
  *
+ * @section thread_safety_sec Thread safety
+ *
+ * Add some stuff for thread safety doc
+ *
+ * @section debugging_sec Debugging
+ *
+ * Add some stuff for the debug doc
+ *
  * @todo add debug function
  * @todo add magic function
  * @todo add other todo items :)

diff --git a/src/include/eina_rectangle.h b/src/include/eina_rectangle.h
index bc47100..0305a1d 100644 (file)
--- a/src/include/eina_rectangle.h
+++ b/src/include/eina_rectangle.h
@@ -19,12 +19,19 @@
 #ifndef EINA_RECTANGLE_H_
 #define EINA_RECTANGLE_H_
 
+#include "eina_types.h"
+
 /**
- * @file
+ * @addtogroup Eina_Tools_Group Tools
+ *
  * @{
  */
 
-#include "eina_types.h"
+/**
+ * @defgroup Eina_Rectangle_Group Rectangle
+ *
+ * @{
+ */
 
 /**
  * To be documented
@@ -65,6 +72,20 @@ EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) EINA_PURE EINA_ARG
 EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool, int w, int h) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
 EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
 
+/**
+ * @def EINA_RECTANGLE_SET
+ * @brief Macro to set the values of a #Eina_Rectangle.
+ *
+ * @param Rectangle The rectangle to set the values.
+ * @param X The X coordinate of the top left corner of the rectangle.
+ * @param Y The Y coordinate of the top left corner of the rectangle.
+ * @param W The width of the rectangle.
+ * @param H The height of the rectangle.
+ *
+ * This macro set the values of @p Rectangle. (@p X, @p Y) is the
+ * coordinates of the top left corner of @p Rectangle, @p W is its
+ * width and @p H is its height.
+ */
 #define EINA_RECTANGLE_SET(Rectangle, X, Y, W, H) \
   (Rectangle)->x = X;                            \
   (Rectangle)->y = Y;                            \
@@ -76,6 +97,12 @@ EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(1);
 
 #include "eina_inline_rectangle.x"
 
-/** @} */
+/**
+ * @}
+ */
+
+/**
+ * @}
+ */
 
 #endif /*_EINA_RECTANGLE_H_*/

diff --git a/src/include/eina_trash.h b/src/include/eina_trash.h
index 358fb62..f69efb8 100644 (file)
--- a/src/include/eina_trash.h
+++ b/src/include/eina_trash.h
@@ -49,7 +49,7 @@ typedef struct _Eina_Trash Eina_Trash;
  */
 struct _Eina_Trash
 {
-   Eina_Trash *next;
+   Eina_Trash *next; /**< next item in trash. */
 };
 
 static inline void eina_trash_init(Eina_Trash **trash) EINA_ARG_NONNULL(1);
@@ -57,7 +57,7 @@ static inline void eina_trash_push(Eina_Trash **trash, void *data) EINA_ARG_NONN
 static inline void *eina_trash_pop(Eina_Trash **trash) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
 
 /**
- * @def EINA_TRASH_FOREACH
+ * @def EINA_TRASH_CLEAN
  * @brief Macro to remove all pointer from the trash.
  *
  * @param trash The trash to clean.

diff --git a/src/lib/eina_module.c b/src/lib/eina_module.c
index aa6cdbc..137c232 100644 (file)
--- a/src/lib/eina_module.c
+++ b/src/lib/eina_module.c
@@ -75,9 +75,6 @@ void *alloca (size_t);
 #define EINA_MODULE_SYMBOL_INIT "__eina_module_init"
 #define EINA_MODULE_SYMBOL_SHUTDOWN "__eina_module_shutdown"
 
-EAPI Eina_Error EINA_ERROR_WRONG_MODULE = 0;
-EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED = 0;
-
 struct _Eina_Module
 {
        char *file;
@@ -167,6 +164,17 @@ static int _eina_module_count = 0;
  */
 
 /**
+ * @cond LOCAL
+ */
+
+EAPI Eina_Error EINA_ERROR_WRONG_MODULE = 0;
+EAPI Eina_Error EINA_ERROR_MODULE_INIT_FAILED = 0;
+
+/**
+ * @endcond
+ */
+
+/**
  * @brief Initialize the eina module internal structure.
  *
  * @return 1 or greater on success, 0 on error.
@@ -385,7 +393,7 @@ EAPI Eina_Bool eina_module_unload(Eina_Module *m)
 /**
  * @brief Retrive the data associated to a symbol.
  *
- * @param The module.
+ * @param m The module.
  * @param symbol The symbol.
  * @return The data associated to the symbol, or @c NULL on failure.
  *
@@ -488,6 +496,7 @@ EAPI char *eina_module_environment_path_get(const char *env, const char *sub_dir
 /**
  * Get a list of modules found on the directory path
  *
+ * @param array The array that stores the list of the modules.
  * @param path The directory's path to search for modules
  * @param recursive Iterate recursively on the path
  * @param cb Callback function to call, if the return value of the callback is zero
@@ -515,7 +524,7 @@ EAPI Eina_Array * eina_module_list_get(Eina_Array *array, const char *path, unsi
 
 /**
  * Load every module on the list of modules
- * @param list The list of modules
+ * @param array The array of modules to load
  */
 EAPI void eina_module_list_load(Eina_Array *array)
 {
@@ -529,6 +538,10 @@ EAPI void eina_module_list_load(Eina_Array *array)
                eina_module_load(m);
 }
 
+/**
+ * Unload every module on the list of modules
+ * @param array The array of modules to unload
+ */
 EAPI void eina_module_list_unload(Eina_Array *array)
 {
        Eina_Array_Iterator iterator;