more doxy from vtorri

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

diff --git a/src/include/Eina.h b/src/include/Eina.h
index 717e59c..dad45a2 100644 (file)
--- a/src/include/Eina.h
+++ b/src/include/Eina.h
@@ -93,7 +93,7 @@
  * @li @ref Eina_Safety_Checks_Group extra checks that will report unexpected conditions and can be disabled at compile time.
  * @li @ref Eina_String_Group a set of functions that manages C strings.
  *
- * @defgroup Eina_Data_Types_Group
+ * @defgroup Eina_Data_Types_Group Data types.
  *
  * Eina provide easy to use and optimized data types and structures.
  *

diff --git a/src/include/eina_binshare.h b/src/include/eina_binshare.h
index a2ea501..e785ed0 100644 (file)
--- a/src/include/eina_binshare.h
+++ b/src/include/eina_binshare.h
@@ -77,7 +77,7 @@ EAPI void         eina_binshare_dump(void);
 /**
  * @brief Retrieve an instance of a blob for use in a program.
  *
- * @param   obj The binary blob to retrieve an instance of.
+ * @param   ptr The binary blob to retrieve an instance of.
  * @return  A pointer to an instance of the string on success.
  *          @c NULL on failure.
  *

diff --git a/src/include/eina_inline_mempool.x b/src/include/eina_inline_mempool.x
index 1f4f628..3f44b90 100644 (file)
--- a/src/include/eina_inline_mempool.x
+++ b/src/include/eina_inline_mempool.x
@@ -19,6 +19,12 @@
 #ifndef EINA_INLINE_MEMPOOL_X_
 #define EINA_INLINE_MEMPOOL_X_
 
+/**
+ * @addtogroup Eina_Memory_Pool_Group Memory Pool
+ *
+ * @{
+ */
+
 /* Memory Pool */
 struct _Eina_Mempool_Backend
 {
@@ -38,22 +44,62 @@ struct _Eina_Mempool
    void *backend_data;
 };
 
+/**
+ * @brief Re-allocate a amount memory by the given mempool.
+ *
+ * @param mp The mempool.
+ * @param element The element to re-allocate.
+ * @param size The size in bytes to re-allocate.
+ * @return The newly re-allocated data.
+ *
+ * This function re-allocates @p element with @p size bytes, using the
+ * mempool @p mp and returns the allocated data. If not used anymore,
+ * the data must be freed with eina_mempool_free(). No check is done
+ * on @p mp, so it must be a valid mempool.
+ */
 static inline void *
 eina_mempool_realloc(Eina_Mempool *mp, void *element, unsigned int size)
 {
    return mp->backend.realloc(mp->backend_data, element, size);
 }
 
+/**
+ * @brief Allocate a amount memory by the given mempool.
+ *
+ * @param mp The mempool.
+ * @param size The size in bytes to allocate.
+ * @return The newly allocated data.
+ *
+ * This function allocates @p size bytes, using the mempool @p mp and
+ * returns the allocated data. If not used anymore, the data must be
+ * freed with eina_mempool_free(). No check is done on @p mp, so it
+ * must be a valid mempool.
+ */
 static inline void *
 eina_mempool_malloc(Eina_Mempool *mp, unsigned int size)
 {
    return mp->backend.alloc(mp->backend_data, size);
 }
 
+/**
+ * @brief Free the allocated ressources by the given mempool.
+ *
+ * @param mp The mempool.
+ * @param element The data to free.
+ *
+ * This function frees @p element allocated by @p mp. @p element must
+ * have been obtained by eina_mempool_malloc() or
+ * eina_mempool_realloc(). No check is done on @p mp, so it must be a
+ * valid mempool.
+ */
 static inline void
 eina_mempool_free(Eina_Mempool *mp, void *element)
 {
    mp->backend.free(mp->backend_data, element);
 }
 
+/**
+ * @}
+ */
+
 #endif

diff --git a/src/include/eina_inline_rectangle.x b/src/include/eina_inline_rectangle.x
index eb0cecf..29ad24b 100644 (file)
--- a/src/include/eina_inline_rectangle.x
+++ b/src/include/eina_inline_rectangle.x
@@ -20,6 +20,14 @@
 #define EINA_INLINE_RECTANGLE_H__
 
 /**
+ * @addtogroup Eina_Rectangle_Group Rectangle
+ *
+ * @brief These functions provide rectangle management.
+ *
+ * @{
+ */
+
+/**
  * @brief Check if the given spans intersect.
  *
  * @param c1 The column of the first span.
@@ -150,7 +158,7 @@ eina_rectangle_coords_inside(const Eina_Rectangle *r, int x, int y)
  * @param dst The first rectangle.
  * @param src The second rectangle.
  *
- * This function get the union of the rectangles @dst and @p src. The
+ * This function get the union of the rectangles @p dst and @p src. The
  * result is stored in @p dst. No check is done on @p dst or @p src,
  * so they must be valid rectangles.
  */
@@ -239,4 +247,8 @@ eina_rectangle_rescale_out(const Eina_Rectangle *out, const Eina_Rectangle *in,
        res->h = out->h;
 }
 
+/**
+ * @}
+ */
+
 #endif

diff --git a/src/include/eina_inline_tiler.x b/src/include/eina_inline_tiler.x
index 7563561..ffc34c1 100644 (file)
--- a/src/include/eina_inline_tiler.x
+++ b/src/include/eina_inline_tiler.x
@@ -22,6 +22,7 @@
 #include "eina_safety_checks.h"
 
 /**
+ * @cond LOCAL
  * This struct should not be accessed directly, it is used by
  * eina_tile_grid_slicer functions to maintain context and fill "info"
  * member with correct values for given iteration.
@@ -38,6 +39,10 @@ struct _Eina_Tile_Grid_Slicer
 };
 
 /**
+ * @endcond
+ */
+
+/**
  * @brief Iterates over the tiles set by eina_tile_grid_slicer_setup().
  *
  * @param   slc Pointer to an Eina_Tile_Grid_Slicer struct.

diff --git a/src/lib/eina_rectangle.c b/src/lib/eina_rectangle.c
index 713ab09..9ef0451 100644 (file)
--- a/src/lib/eina_rectangle.c
+++ b/src/lib/eina_rectangle.c
@@ -321,6 +321,14 @@ eina_rectangle_shutdown(void)
 *============================================================================*/
 
 /**
+ * @addtogroup Eina_Rectangle_Group Rectangle
+ *
+ * @brief These functions provide rectangle management.
+ *
+ * @{
+ */
+
+/**
  * @brief Create a new rectangle.
  *
  * @param x The X coordinate of the top left corner of the rectangle.
@@ -679,3 +687,6 @@ eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *pool, int *w, int *h)
    return EINA_TRUE;
 }
 
+/**
+ * @}
+ */