summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-11-13 12:09:21 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-11-13 12:09:21 +0900
commit7764abe8f60e88749c2f2f09383dfdccfb8ce4d2 (patch)
treec5ae36561ef28e0c65464f12485c5d0614327677 /src
parent6505f535f681bbca21c7f60878fe13414641b8f8 (diff)
eina: Fix spelling/punctuation errors in docs (quaternion..rectangle)
Reviewers: cedric, ajwillia.ms Subscribers: segfaultxavi, jpeg Differential Revision: https://phab.enlightenment.org/D5450
Diffstat (limited to 'src')
-rw-r--r--src/lib/eina/eina_quaternion.h4
-rw-r--r--src/lib/eina/eina_rbtree.h35
-rw-r--r--src/lib/eina/eina_rectangle.h35
3 files changed, 34 insertions, 40 deletions
diff --git a/src/lib/eina/eina_quaternion.h b/src/lib/eina/eina_quaternion.h
index 9606036c88..156d12b213 100644
--- a/src/lib/eina/eina_quaternion.h
+++ b/src/lib/eina/eina_quaternion.h
@@ -144,10 +144,10 @@ EAPI void eina_quaternion_matrix4_to(Eina_Matrix4 *m,
144/** 144/**
145 * @brief Compute the inverse of the given quaternion. 145 * @brief Compute the inverse of the given quaternion.
146 * 146 *
147 * @param out The quaternion to inverse. 147 * @param out The quaternion to invert.
148 * @param q The quaternion matrix. 148 * @param q The quaternion matrix.
149 * 149 *
150 * This function inverse the quaternion @p q and stores the result in 150 * This function inverses the quaternion @p q and stores the result in
151 * @p out. 151 * @p out.
152 * 152 *
153 * @since 1.17 153 * @since 1.17
diff --git a/src/lib/eina/eina_rbtree.h b/src/lib/eina/eina_rbtree.h
index fad916aa66..ae0f82d2af 100644
--- a/src/lib/eina/eina_rbtree.h
+++ b/src/lib/eina/eina_rbtree.h
@@ -28,12 +28,12 @@
28/** 28/**
29 * @addtogroup Eina_Rbtree_Group Red-Black tree 29 * @addtogroup Eina_Rbtree_Group Red-Black tree
30 * 30 *
31 * @brief These functions provide Red-Black trees management. 31 * @brief These functions provide Red-Black tree management.
32 * 32 *
33 * For a brief description look at http://en.wikipedia.org/wiki/Red-black_tree . 33 * For a brief description look at http://en.wikipedia.org/wiki/Red-black_tree .
34 * This code is largely inspired from a tutorial written by Julienne Walker at : 34 * This code is largely inspired from a tutorial written by Julienne Walker at :
35 * http://eternallyconfuzzled.com/tuts/datastructures/jsw_tut_rbtree.aspx . The 35 * http://eternallyconfuzzled.com/tuts/datastructures/jsw_tut_rbtree.aspx . The
36 * main difference is that this set of function never allocate any data, making 36 * main difference is that this set of functions never allocate any data, making
37 * them particularly useful for memory management. 37 * them particularly useful for memory management.
38 */ 38 */
39 39
@@ -109,13 +109,13 @@ struct _Eina_Rbtree
109 109
110/** 110/**
111 * @def EINA_RBTREE_CONTAINER_GET 111 * @def EINA_RBTREE_CONTAINER_GET
112 * find back the container of an red black tree. 112 * find back the container of a red black tree.
113 */ 113 */
114#define EINA_RBTREE_CONTAINER_GET(Ptr, Type) ((Type *)((char *)Ptr - offsetof(Type, __rbtree))) 114#define EINA_RBTREE_CONTAINER_GET(Ptr, Type) ((Type *)((char *)Ptr - offsetof(Type, __rbtree)))
115 115
116/** 116/**
117 * @typedef Eina_Rbtree_Cmp_Node_Cb 117 * @typedef Eina_Rbtree_Cmp_Node_Cb
118 * Function used compare two nodes and see which direction to navigate. 118 * Function used to compare two nodes and see which direction to navigate.
119 */ 119 */
120typedef Eina_Rbtree_Direction (*Eina_Rbtree_Cmp_Node_Cb)(const Eina_Rbtree *left, const Eina_Rbtree *right, void *data); 120typedef Eina_Rbtree_Direction (*Eina_Rbtree_Cmp_Node_Cb)(const Eina_Rbtree *left, const Eina_Rbtree *right, void *data);
121 121
@@ -130,6 +130,7 @@ typedef Eina_Rbtree_Direction (*Eina_Rbtree_Cmp_Node_Cb)(const Eina_Rbtree *left
130 * Function used compare node with a given key of specified length. 130 * Function used compare node with a given key of specified length.
131 */ 131 */
132typedef int (*Eina_Rbtree_Cmp_Key_Cb)(const Eina_Rbtree *node, const void *key, int length, void *data); 132typedef int (*Eina_Rbtree_Cmp_Key_Cb)(const Eina_Rbtree *node, const void *key, int length, void *data);
133
133/** 134/**
134 * @def EINA_RBTREE_CMP_KEY_CB 135 * @def EINA_RBTREE_CMP_KEY_CB
135 * Cast using #Eina_Rbtree_Cmp_Key_Cb 136 * Cast using #Eina_Rbtree_Cmp_Key_Cb
@@ -138,16 +139,16 @@ typedef int (*Eina_Rbtree_Cmp_Key_Cb)(const Eina_Rbtree *node, const void *key,
138 139
139/** 140/**
140 * @typedef Eina_Rbtree_Free_Cb 141 * @typedef Eina_Rbtree_Free_Cb
141 * Function used free a node. 142 * Function used to free a node.
142 */ 143 */
143typedef void (*Eina_Rbtree_Free_Cb)(Eina_Rbtree *node, void *data); 144typedef void (*Eina_Rbtree_Free_Cb)(Eina_Rbtree *node, void *data);
145
144/** 146/**
145 * @def EINA_RBTREE_FREE_CB 147 * @def EINA_RBTREE_FREE_CB
146 * Cast using #Eina_Rbtree_Free_Cb 148 * Cast using #Eina_Rbtree_Free_Cb
147 */ 149 */
148#define EINA_RBTREE_FREE_CB(Function) ((Eina_Rbtree_Free_Cb)Function) 150#define EINA_RBTREE_FREE_CB(Function) ((Eina_Rbtree_Free_Cb)Function)
149 151
150
151/** 152/**
152 * @brief Inserts a new node inside an existing red black tree. 153 * @brief Inserts a new node inside an existing red black tree.
153 * 154 *
@@ -157,7 +158,7 @@ typedef void (*Eina_Rbtree_Free_Cb)(Eina_Rbtree *node, void *data);
157 * @param data Private data to help the compare function. 158 * @param data Private data to help the compare function.
158 * @return The new root of the red black tree. 159 * @return The new root of the red black tree.
159 * 160 *
160 * This function insert a new node in a valid red black tree. @c NULL is 161 * This function inserts a new node in a valid red black tree. @c NULL is
161 * an empty valid red black tree. The resulting new tree is a valid red 162 * an empty valid red black tree. The resulting new tree is a valid red
162 * black tree. This function doesn't allocate any data. 163 * black tree. This function doesn't allocate any data.
163 */ 164 */
@@ -172,7 +173,7 @@ EAPI Eina_Rbtree *eina_rbtree_inline_insert(Eina_Rbtree *root, Eina_Rbt
172 * @param data Private data to help the compare function. 173 * @param data Private data to help the compare function.
173 * @return The new root of the red black tree. 174 * @return The new root of the red black tree.
174 * 175 *
175 * This function remove a new node in a valid red black tree that should 176 * This function removes a new node in a valid red black tree that should
176 * contain the node that you are removing. This function will return @c NULL 177 * contain the node that you are removing. This function will return @c NULL
177 * when the red black tree got empty. This function doesn't free any data. 178 * when the red black tree got empty. This function doesn't free any data.
178 */ 179 */
@@ -203,17 +204,17 @@ static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, co
203 204
204 205
205/** 206/**
206 * @brief Returns a new prefix iterator associated to a rbtree. 207 * @brief Returns a new prefix iterator associated with a rbtree.
207 * 208 *
208 * @param root The root of rbtree. 209 * @param root The root of rbtree.
209 * @return A new iterator. 210 * @return A new iterator.
210 * 211 *
211 * This function returns a newly allocated iterator associated to @p 212 * This function returns a newly allocated iterator associated with @p
212 * root. It will iterate the tree using prefix walk. If @p root is @c 213 * root. It will iterate the tree using prefix walk. If @p root is @c
213 * NULL, this function still returns a valid iterator that will always 214 * NULL, this function still returns a valid iterator that will always
214 * return false on eina_iterator_next(), thus keeping API sane. 215 * return false on eina_iterator_next(), thus keeping API sane.
215 * 216 *
216 * If the memory can not be allocated, @c NULL is returned. 217 * If the memory cannot be allocated, @c NULL is returned.
217 * Otherwise, a valid iterator is returned. 218 * Otherwise, a valid iterator is returned.
218 * 219 *
219 * @warning if the rbtree structure changes then the iterator becomes 220 * @warning if the rbtree structure changes then the iterator becomes
@@ -223,17 +224,17 @@ static inline Eina_Rbtree *eina_rbtree_inline_lookup(const Eina_Rbtree *root, co
223EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT; 224EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
224 225
225/** 226/**
226 * @brief Returns a new prefix iterator associated to a rbtree. 227 * @brief Returns a new prefix iterator associated with a rbtree.
227 * 228 *
228 * @param root The root of rbtree. 229 * @param root The root of rbtree.
229 * @return A new iterator. 230 * @return A new iterator.
230 * 231 *
231 * This function returns a newly allocated iterator associated to @p 232 * This function returns a newly allocated iterator associated with @p
232 * root. It will iterate the tree using infix walk. If @p root is @c 233 * root. It will iterate the tree using infix walk. If @p root is @c
233 * NULL, this function still returns a valid iterator that will always 234 * NULL, this function still returns a valid iterator that will always
234 * return false on eina_iterator_next(), thus keeping API sane. 235 * return false on eina_iterator_next(), thus keeping API sane.
235 * 236 *
236 * If the memory can not be allocated, @c NULL is returned. 237 * If the memory cannot be allocated, @c NULL is returned.
237 * Otherwise, a valid iterator is returned. 238 * Otherwise, a valid iterator is returned.
238 * 239 *
239 * @warning if the rbtree structure changes then the iterator becomes 240 * @warning if the rbtree structure changes then the iterator becomes
@@ -243,17 +244,17 @@ EAPI Eina_Iterator *eina_rbtree_iterator_prefix(const Eina_Rbtree *root)
243EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT; 244EAPI Eina_Iterator *eina_rbtree_iterator_infix(const Eina_Rbtree *root) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
244 245
245/** 246/**
246 * @brief Returns a new prefix iterator associated to a rbtree. 247 * @brief Returns a new prefix iterator associated with a rbtree.
247 * 248 *
248 * @param root The root of rbtree. 249 * @param root The root of rbtree.
249 * @return A new iterator. 250 * @return A new iterator.
250 * 251 *
251 * This function returns a newly allocated iterator associated to @p 252 * This function returns a newly allocated iterator associated with @p
252 * root. It will iterate the tree using postfix walk. If @p root is @c 253 * root. It will iterate the tree using postfix walk. If @p root is @c
253 * NULL, this function still returns a valid iterator that will always 254 * NULL, this function still returns a valid iterator that will always
254 * return false on eina_iterator_next(), thus keeping API sane. 255 * return false on eina_iterator_next(), thus keeping API sane.
255 * 256 *
256 * If the memory can not be allocated, @c NULL is returned. 257 * If the memory cannot be allocated, @c NULL is returned.
257 * Otherwise, a valid iterator is returned. 258 * Otherwise, a valid iterator is returned.
258 * 259 *
259 * @warning if the rbtree structure changes then the iterator becomes 260 * @warning if the rbtree structure changes then the iterator becomes
diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h
index 0f3cdb5550..24a03e7dc5 100644
--- a/src/lib/eina/eina_rectangle.h
+++ b/src/lib/eina/eina_rectangle.h
@@ -107,7 +107,7 @@ typedef enum {
107 107
108/** 108/**
109 * @typedef Eina_Rectangle_Outside 109 * @typedef Eina_Rectangle_Outside
110 * Enumeration gives the positions where a rectangle can be outside a other rectangle 110 * Enumeration gives the positions where a rectangle can be outside another rectangle
111 * @since 1.19 111 * @since 1.19
112 */ 112 */
113typedef enum { 113typedef enum {
@@ -127,7 +127,7 @@ typedef enum {
127 * @param l2 The length of the second span. 127 * @param l2 The length of the second span.
128 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 128 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
129 * 129 *
130 * This function returns #EINA_TRUE if the given spans intersect, #EINA_FALSE 130 * This function returns #EINA_TRUE if the given spans intersect, #EINA_FALSE
131 * otherwise. 131 * otherwise.
132 */ 132 */
133static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT; 133static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT;
@@ -173,7 +173,7 @@ static inline void eina_rectangle_coords_from(Eina_Rectangle *r, int x, i
173static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *r1, const Eina_Rectangle *r2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT; 173static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *r1, const Eina_Rectangle *r2) EINA_ARG_NONNULL(1, 2) EINA_WARN_UNUSED_RESULT;
174 174
175/** 175/**
176 * @brief Checks if the given x-coordinate is in the rectangle . 176 * @brief Checks if the given x-coordinate is in the rectangle.
177 * 177 *
178 * @param r The rectangle. 178 * @param r The rectangle.
179 * @param x The x coordinate. 179 * @param x The x coordinate.
@@ -186,7 +186,7 @@ static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *r1, co
186static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *r, int x) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 186static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *r, int x) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
187 187
188/** 188/**
189 * @brief Checks if the given y-coordinate is in the rectangle . 189 * @brief Checks if the given y-coordinate is in the rectangle.
190 * 190 *
191 * @param r The rectangle. 191 * @param r The rectangle.
192 * @param y The y coordinate. 192 * @param y The y coordinate.
@@ -199,7 +199,7 @@ static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *r,
199static inline Eina_Bool eina_rectangle_ycoord_inside(const Eina_Rectangle *r, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT; 199static inline Eina_Bool eina_rectangle_ycoord_inside(const Eina_Rectangle *r, int y) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
200 200
201/** 201/**
202 * @brief Checks if the given point is in the rectangle . 202 * @brief Checks if the given point is in the rectangle.
203 * 203 *
204 * @param r The rectangle. 204 * @param r The rectangle.
205 * @param x The x coordinate of the point. 205 * @param x The x coordinate of the point.
@@ -218,7 +218,7 @@ static inline Eina_Bool eina_rectangle_coords_inside(const Eina_Rectangle *r,
218 * @param dst The first rectangle. 218 * @param dst The first rectangle.
219 * @param src The second rectangle. 219 * @param src The second rectangle.
220 * 220 *
221 * This function get the union of the rectangles @p dst and @p src. The 221 * This function gets the union of the rectangles @p dst and @p src. The
222 * result is stored in @p dst. No check is done on @p dst or @p src, 222 * result is stored in @p dst. No check is done on @p dst or @p src,
223 * so they must be valid rectangles. 223 * so they must be valid rectangles.
224 */ 224 */
@@ -232,7 +232,7 @@ static inline void eina_rectangle_union(Eina_Rectangle *dst, const Eina_R
232 * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE 232 * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE
233 * otherwise. 233 * otherwise.
234 * 234 *
235 * This function get the intersection of the rectangles @p dst and 235 * This function gets the intersection of the rectangles @p dst and
236 * @p src. The result is stored in @p dst. No check is done on @p dst 236 * @p src. The result is stored in @p dst. No check is done on @p dst
237 * or @p src, so they must be valid rectangles. 237 * or @p src, so they must be valid rectangles.
238 */ 238 */
@@ -259,7 +259,6 @@ static inline void eina_rectangle_rescale_in(const Eina_Rectangle *out, c
259static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3); 259static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out, const Eina_Rectangle *in, Eina_Rectangle *res) EINA_ARG_NONNULL(1, 2, 3);
260 260
261/** 261/**
262 *
263 * @brief Tells whether a rectangle is valid or not. 262 * @brief Tells whether a rectangle is valid or not.
264 * 263 *
265 * @param r The rectangle 264 * @param r The rectangle
@@ -272,7 +271,6 @@ static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out,
272static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *r) EINA_ARG_NONNULL(1); 271static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *r) EINA_ARG_NONNULL(1);
273 272
274/** 273/**
275 *
276 * @brief Gives the rectangle maximum x coordinate. 274 * @brief Gives the rectangle maximum x coordinate.
277 * 275 *
278 * @param thiz The rectangle 276 * @param thiz The rectangle
@@ -284,7 +282,6 @@ static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *r) EINA_
284static inline int eina_rectangle_max_x(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1); 282static inline int eina_rectangle_max_x(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1);
285 283
286/** 284/**
287 *
288 * @brief Gives the rectangle maximum y coordinate. 285 * @brief Gives the rectangle maximum y coordinate.
289 * 286 *
290 * @param thiz The rectangle 287 * @param thiz The rectangle
@@ -296,7 +293,6 @@ static inline int eina_rectangle_max_x(Eina_Rectangle *thiz) EINA_ARG_NO
296static inline int eina_rectangle_max_y(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1); 293static inline int eina_rectangle_max_y(Eina_Rectangle *thiz) EINA_ARG_NONNULL(1);
297 294
298/** 295/**
299 *
300 * @brief Slices a rectangle vertically into two subrectangles starting from left edge. 296 * @brief Slices a rectangle vertically into two subrectangles starting from left edge.
301 * 297 *
302 * @param thiz The rectangle to slice 298 * @param thiz The rectangle to slice
@@ -309,13 +305,12 @@ static inline int eina_rectangle_max_y(Eina_Rectangle *thiz) EINA_ARG_NO
309 * Use this function if we must cut a rectangle vertically. The @p amount 305 * Use this function if we must cut a rectangle vertically. The @p amount
310 * parameter defines the x inner coordinate where to do the cut, starting from 306 * parameter defines the x inner coordinate where to do the cut, starting from
311 * the left edge of the rectangle. If the @p amount value is greater than the 307 * the left edge of the rectangle. If the @p amount value is greater than the
312 * rectangle width, there will be not cut possible and #EINA_FALSE will be 308 * rectangle width, there will be no cut possible and #EINA_FALSE will be
313 * returned. 309 * returned.
314 */ 310 */
315static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1); 311static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
316 312
317/** 313/**
318 *
319 * @brief Slices a rectangle horizontally into two subrectangles starting from bottom edge 314 * @brief Slices a rectangle horizontally into two subrectangles starting from bottom edge
320 * 315 *
321 * @param thiz The rectangle to slice 316 * @param thiz The rectangle to slice
@@ -328,13 +323,12 @@ static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *thiz, Eina_Rectan
328 * Use this function if we must cut a rectangle horizontally. The @p amount 323 * Use this function if we must cut a rectangle horizontally. The @p amount
329 * parameter defines the y inner coordinate where to do the cut, starting from 324 * parameter defines the y inner coordinate where to do the cut, starting from
330 * the bottom edge of the rectangle. If the @p amount value is greater than the 325 * the bottom edge of the rectangle. If the @p amount value is greater than the
331 * rectangle width, there will be not cut possible and #EINA_FALSE will be 326 * rectangle width, there will be no cut possible and #EINA_FALSE will be
332 * returned. 327 * returned.
333 */ 328 */
334static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1); 329static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
335 330
336/** 331/**
337 *
338 * @brief Slices a rectangle vertically starting from right edge 332 * @brief Slices a rectangle vertically starting from right edge
339 * 333 *
340 * @param thiz The rectangle to slice 334 * @param thiz The rectangle to slice
@@ -347,13 +341,12 @@ static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *thiz, Eina_Rectan
347 * Use this function if we must cut a rectangle vertically. The @p amount 341 * Use this function if we must cut a rectangle vertically. The @p amount
348 * parameter defines the inner x coordinate where to do the cut, starting from 342 * parameter defines the inner x coordinate where to do the cut, starting from
349 * the right edge of the rectangle. If the @p amount value is greater than the 343 * the right edge of the rectangle. If the @p amount value is greater than the
350 * rectangle width, there will be not cut possible and #EINA_FALSE will be 344 * rectangle width, there will be no cut possible and #EINA_FALSE will be
351 * returned. 345 * returned.
352 */ 346 */
353static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1); 347static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
354 348
355/** 349/**
356 *
357 * @brief Slices a rectangle horizontally starting from top edge 350 * @brief Slices a rectangle horizontally starting from top edge
358 * 351 *
359 * @param thiz The rectangle to slice 352 * @param thiz The rectangle to slice
@@ -365,7 +358,7 @@ static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *thiz, Eina_Re
365 * Use this function if we must cut a rectangle horizontally. The @p amount 358 * Use this function if we must cut a rectangle horizontally. The @p amount
366 * parameter defines the inner y coordinate where to do the cut, starting from 359 * parameter defines the inner y coordinate where to do the cut, starting from
367 * the top edge of the rectangle. If the @p amount value is greater than the 360 * the top edge of the rectangle. If the @p amount value is greater than the
368 * rectangle width, there will be not cut possible and #EINA_FALSE will be 361 * rectangle width, there will be no cut possible and #EINA_FALSE will be
369 * returned. 362 * returned.
370 */ 363 */
371static inline Eina_Bool eina_rectangle_height_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1); 364static inline Eina_Bool eina_rectangle_height_cut(Eina_Rectangle *thiz, Eina_Rectangle *slice, Eina_Rectangle *remainder, int amount) EINA_ARG_NONNULL(1);
@@ -474,7 +467,7 @@ EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) E
474 * @param h The height of the rectangle to request. 467 * @param h The height of the rectangle to request.
475 * @return The requested rectangle on success, @c NULL otherwise. 468 * @return The requested rectangle on success, @c NULL otherwise.
476 * 469 *
477 * This function retrieve from @p pool the rectangle of width @p w and 470 * This function retrieves from @p pool the rectangle of width @p w and
478 * height @p h. If @p pool is @c NULL, or @p w or @p h are non-positive, 471 * height @p h. If @p pool is @c NULL, or @p w or @p h are non-positive,
479 * the function returns @c NULL. If @p w or @p h are greater than the 472 * the function returns @c NULL. If @p w or @p h are greater than the
480 * pool size, the function returns @c NULL. On success, the function 473 * pool size, the function returns @c NULL. On success, the function
@@ -528,7 +521,7 @@ EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA
528 * @param h The height of the rectangle. 521 * @param h The height of the rectangle.
529 * @return The new rectangle on success, @ NULL otherwise. 522 * @return The new rectangle on success, @ NULL otherwise.
530 * 523 *
531 * This function creates a rectangle which top left corner has the 524 * This function creates a rectangle whose top left corner has the
532 * coordinates (@p x, @p y), with height @p w and height @p h and adds 525 * coordinates (@p x, @p y), with height @p w and height @p h and adds
533 * it to the rectangles pool. No check is done on @p w and @p h. This 526 * it to the rectangles pool. No check is done on @p w and @p h. This
534 * function returns a new rectangle on success, @c NULL otherwise. 527 * function returns a new rectangle on success, @c NULL otherwise.
@@ -562,7 +555,7 @@ EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,E
562 * @param rect1 The rect to use as anchor 555 * @param rect1 The rect to use as anchor
563 * @param rect2 The rect to look for outside positions 556 * @param rect2 The rect to look for outside positions
564 * 557 *
565 * @return A or'ed map of Eina_Rectangle_Outside values 558 * @return An OR'd map of Eina_Rectangle_Outside values
566 * @since 1.19 559 * @since 1.19
567 */ 560 */
568EAPI Eina_Rectangle_Outside eina_rectangle_outside_position(Eina_Rectangle *rect1, Eina_Rectangle *rect2); 561EAPI Eina_Rectangle_Outside eina_rectangle_outside_position(Eina_Rectangle *rect1, Eina_Rectangle *rect2);