eina: add missing documentation for rectangle. 02/156302/2
authorBowon Ryu <bowon.ryu@samsung.com>
Tue, 17 Oct 2017 17:56:12 +0000 (10:56 -0700)
committerBowon Ryu <bowon.ryu@samsung.com>
Wed, 18 Oct 2017 05:18:34 +0000 (05:18 +0000)
Summary: This adds missing doxgen documentation for eina_rectangle.

Test Plan: API Doxygen Revision

Reviewers: cedric, jpeg, myoungwoon

Reviewed By: cedric

Differential Revision: https://phab.enlightenment.org/D5331

Change-Id: Iee180c3d42ec1d272f2b45269df6a3edc7699a10
Signed-off-by: Cedric Bail <cedric@osg.samsung.com>
Signed-off-by: Bowon Ryu <bowon.ryu@samsung.com>
src/lib/eina/eina_rectangle.h

index 9026e84..445c62d 100644 (file)
@@ -329,8 +329,10 @@ static inline Eina_Bool   eina_rectangle_height_cut(Eina_Rectangle *thiz, Eina_R
 /**
  * @brief Subtracts two rectangles.
  *
- * @param thiz The minuend rectangle
- * @param other The subtrahend rectangle
+ * @param thiz The minuend rectangle.
+ * @param other The subtrahend rectangle.
+ * @param out Stored the difference between two rectangles.
+ * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
  *
  * This function subtract two rectangles. The difference is stored on @p out
  * There will be at most four differences, use eina_rectangle_is_valid to
@@ -544,6 +546,7 @@ EAPI void            eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(
  * @brief Sets the type of given rectangle pool.
  *
  * @param pool The rectangle pool for which type is to be set.
+ * @param type Type of Eina Pool based on packing algorithm.
  *
  * This function sets @p type of @p pool.
  * @see Eina_Rectangle_Packing