From: Bowon Ryu Date: Tue, 17 Oct 2017 17:56:12 +0000 (-0700) Subject: eina: add missing documentation for rectangle. X-Git-Tag: submit/sandbox/upgrade/efl120/20180319.053334~2183 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=47f70a43d1408df000ef0b10e5e16e1bd224ba45;p=platform%2Fupstream%2Fefl.git eina: add missing documentation for rectangle. 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 Signed-off-by: Cedric Bail --- diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h index b2792c0..0f3cdb5 100644 --- a/src/lib/eina/eina_rectangle.h +++ b/src/lib/eina/eina_rectangle.h @@ -373,8 +373,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 @@ -546,6 +548,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