summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-08-08 13:52:25 +0900
committerHermet Park <hermetpark@gmail.com>2018-08-08 13:52:25 +0900
commitdd5a78d9c3e702002bc979f30d4d0240fdacbf67 (patch)
treef9cf3376a19610bbf3a04753a4f36528d5051f68 /src/lib/eina
parent117a0ca298d97ce95a031c919f0fa9aa92f651aa (diff)
eina: Add doxygen in/out tags for rectangle
Reviewers: Hermet Reviewed By: Hermet Subscribers: cedric, #reviewers, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6776
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_rectangle.h152
1 files changed, 76 insertions, 76 deletions
diff --git a/src/lib/eina/eina_rectangle.h b/src/lib/eina/eina_rectangle.h
index 10ff050efc..8045bf7a45 100644
--- a/src/lib/eina/eina_rectangle.h
+++ b/src/lib/eina/eina_rectangle.h
@@ -121,10 +121,10 @@ typedef enum {
121/** 121/**
122 * @brief Checks if the given spans intersect. 122 * @brief Checks if the given spans intersect.
123 * 123 *
124 * @param c1 The column of the first span. 124 * @param[in] c1 The column of the first span.
125 * @param l1 The length of the first span. 125 * @param[in] l1 The length of the first span.
126 * @param c2 The column of the second span. 126 * @param[in] c2 The column of the second span.
127 * @param l2 The length of the second span. 127 * @param[in] l2 The length of the second span.
128 * @return #EINA_TRUE if the given spans intersect, #EINA_FALSE otherwise. 128 * @return #EINA_TRUE if the given spans intersect, #EINA_FALSE otherwise.
129 */ 129 */
130static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT; 130static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) EINA_WARN_UNUSED_RESULT;
@@ -132,7 +132,7 @@ static inline int eina_spans_intersect(int c1, int l1, int c2, int l2) E
132/** 132/**
133 * @brief Checks if the given rectangle is empty. 133 * @brief Checks if the given rectangle is empty.
134 * 134 *
135 * @param rect The rectangle to check. 135 * @param[in] rect The rectangle to check.
136 * @return #EINA_TRUE if the rectangle @p r is empty, #EINA_FALSE 136 * @return #EINA_TRUE if the rectangle @p r is empty, #EINA_FALSE
137 * otherwise. 137 * otherwise.
138 * 138 *
@@ -143,11 +143,11 @@ static inline Eina_Bool eina_rectangle_is_empty(const Eina_Rectangle *rect) EI
143/** 143/**
144 * @brief Sets the coordinates and size of a rectangle. 144 * @brief Sets the coordinates and size of a rectangle.
145 * 145 *
146 * @param rect The rectangle. 146 * @param[out] rect The rectangle.
147 * @param x The X coordinate of the rectangle's top-left corner. 147 * @param[in] x The X coordinate of the rectangle's top-left corner.
148 * @param y The Y coordinate of the rectangle's top-left corner. 148 * @param[in] y The Y coordinate of the rectangle's top-left corner.
149 * @param w The width of the rectangle. 149 * @param[in] w The width of the rectangle.
150 * @param h The height of the rectangle. 150 * @param[in] h The height of the rectangle.
151 * 151 *
152 * This function sets its top-left X coordinate to @p x, its top-left 152 * This function sets its top-left X coordinate to @p x, its top-left
153 * Y coordinate to @p y, its width to @p w and its height to @p h. 153 * Y coordinate to @p y, its width to @p w and its height to @p h.
@@ -159,8 +159,8 @@ static inline void eina_rectangle_coords_from(Eina_Rectangle *rect, int x
159/** 159/**
160 * @brief Checks if two rectangles intersect. 160 * @brief Checks if two rectangles intersect.
161 * 161 *
162 * @param rect1 The first rectangle. 162 * @param[in] rect1 The first rectangle.
163 * @param rect2 The second rectangle. 163 * @param[in] rect2 The second rectangle.
164 * @return #EINA_TRUE if the rectangles @p rect1 and @p rect2 intersect, 164 * @return #EINA_TRUE if the rectangles @p rect1 and @p rect2 intersect,
165 * #EINA_FALSE otherwise. 165 * #EINA_FALSE otherwise.
166 * 166 *
@@ -172,8 +172,8 @@ static inline Eina_Bool eina_rectangles_intersect(const Eina_Rectangle *rect1,
172/** 172/**
173 * @brief Checks if the given X-coordinate is in the rectangle. 173 * @brief Checks if the given X-coordinate is in the rectangle.
174 * 174 *
175 * @param rect The rectangle. 175 * @param[in] rect The rectangle.
176 * @param x The X coordinate. 176 * @param[in] x The X coordinate.
177 * @return #EINA_TRUE if @p x is between the rectangle's left and right 177 * @return #EINA_TRUE if @p x is between the rectangle's left and right
178 * edges, #EINA_FALSE otherwise. 178 * edges, #EINA_FALSE otherwise.
179 * 179 *
@@ -184,8 +184,8 @@ static inline Eina_Bool eina_rectangle_xcoord_inside(const Eina_Rectangle *rec
184/** 184/**
185 * @brief Checks if the given Y-coordinate is in the rectangle. 185 * @brief Checks if the given Y-coordinate is in the rectangle.
186 * 186 *
187 * @param rect The rectangle. 187 * @param[in] rect The rectangle.
188 * @param y The Y coordinate. 188 * @param[in] y The Y coordinate.
189 * @return #EINA_TRUE if @p y is between the rectangle's top and bottom 189 * @return #EINA_TRUE if @p y is between the rectangle's top and bottom
190 * edges, #EINA_FALSE otherwise. 190 * edges, #EINA_FALSE otherwise.
191 * 191 *
@@ -196,9 +196,9 @@ static inline Eina_Bool eina_rectangle_ycoord_inside(const Eina_Rectangle *rec
196/** 196/**
197 * @brief Checks if the given point is inside the rectangle. 197 * @brief Checks if the given point is inside the rectangle.
198 * 198 *
199 * @param rect The rectangle. 199 * @param[in] rect The rectangle.
200 * @param x The x coordinate of the point. 200 * @param[in] x The x coordinate of the point.
201 * @param y The y coordinate of the point. 201 * @param[in] y The y coordinate of the point.
202 * @return #EINA_TRUE if the point (@p x, @p y) is within the edges of 202 * @return #EINA_TRUE if the point (@p x, @p y) is within the edges of
203 * @p r, #EINA_FALSE otherwise. 203 * @p r, #EINA_FALSE otherwise.
204 * 204 *
@@ -209,8 +209,8 @@ static inline Eina_Bool eina_rectangle_coords_inside(const Eina_Rectangle *rec
209/** 209/**
210 * @brief Gets the union of two rectangles. 210 * @brief Gets the union of two rectangles.
211 * 211 *
212 * @param dst The first rectangle. 212 * @param[in,out] dst The first rectangle.
213 * @param src The second rectangle. 213 * @param[in] src The second rectangle.
214 * 214 *
215 * Changes @p dst to be the bounding box of both rectangles @p dst and 215 * Changes @p dst to be the bounding box of both rectangles @p dst and
216 * @p src. 216 * @p src.
@@ -223,8 +223,8 @@ static inline void eina_rectangle_union(Eina_Rectangle *dst, const Eina_R
223/** 223/**
224 * @brief Gets the intersection of two rectangles. 224 * @brief Gets the intersection of two rectangles.
225 * 225 *
226 * @param dst The first rectangle. 226 * @param[in,out] dst The first rectangle.
227 * @param src The second rectangle. 227 * @param[in] src The second rectangle.
228 * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE 228 * @return #EINA_TRUE if the rectangles intersect, #EINA_FALSE
229 * otherwise. 229 * otherwise.
230 * 230 *
@@ -260,7 +260,7 @@ static inline void eina_rectangle_rescale_out(const Eina_Rectangle *out,
260/** 260/**
261 * @brief Tells whether a rectangle is valid. 261 * @brief Tells whether a rectangle is valid.
262 * 262 *
263 * @param rect The rectangle. 263 * @param[in] rect The rectangle.
264 * @return #EINA_TRUE if the rectangle is valid, #EINA_FALSE otherwise. 264 * @return #EINA_TRUE if the rectangle is valid, #EINA_FALSE otherwise.
265 * 265 *
266 * This function checks if both width and height attributes of the rectangle are 266 * This function checks if both width and height attributes of the rectangle are
@@ -272,7 +272,7 @@ static inline Eina_Bool eina_rectangle_is_valid(const Eina_Rectangle *rect) EI
272/** 272/**
273 * @brief Gets the rectangle's maximum X coordinate. 273 * @brief Gets the rectangle's maximum X coordinate.
274 * 274 *
275 * @param rect The rectangle. 275 * @param[in] rect The rectangle.
276 * @return The maximum X coordinate. 276 * @return The maximum X coordinate.
277 * 277 *
278 * This function calculates the maximum X coordinate of the rectangle by summing 278 * This function calculates the maximum X coordinate of the rectangle by summing
@@ -283,7 +283,7 @@ static inline int eina_rectangle_max_x(Eina_Rectangle *rect) EINA_ARG_NO
283/** 283/**
284 * @brief Gets the rectangle maximum Y coordinate. 284 * @brief Gets the rectangle maximum Y coordinate.
285 * 285 *
286 * @param rect The rectangle. 286 * @param[in] rect The rectangle.
287 * @return The maximum Y coordinate. 287 * @return The maximum Y coordinate.
288 * 288 *
289 * This function calculates the maximum Y coordinate of the rectangle by summing 289 * This function calculates the maximum Y coordinate of the rectangle by summing
@@ -294,10 +294,10 @@ static inline int eina_rectangle_max_y(Eina_Rectangle *rect) EINA_ARG_NO
294/** 294/**
295 * @brief Slices a rectangle vertically into two subrectangles. 295 * @brief Slices a rectangle vertically into two subrectangles.
296 * 296 *
297 * @param rect The rectangle to slice. 297 * @param[in] rect The rectangle to slice.
298 * @param slice The sliced part of the rectangle. 298 * @param[out] slice The sliced part of the rectangle.
299 * @param remainder The left over part of the rectangle after slicing. 299 * @param[out] remainder The left over part of the rectangle after slicing.
300 * @param amount The slice location's horizontal distance from the left. 300 * @param[in] amount The slice location's horizontal distance from the left.
301 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise. 301 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise.
302 * 302 *
303 * Cut a rectangle vertically at a distance @p amount from the 303 * Cut a rectangle vertically at a distance @p amount from the
@@ -309,10 +309,10 @@ static inline Eina_Bool eina_rectangle_x_cut(Eina_Rectangle *rect, Eina_Rectan
309/** 309/**
310 * @brief Slices a rectangle horizontally into two subrectangles. 310 * @brief Slices a rectangle horizontally into two subrectangles.
311 * 311 *
312 * @param rect The rectangle to slice. 312 * @param[in] rect The rectangle to slice.
313 * @param slice The sliced part of the rectangle. 313 * @param[out] slice The sliced part of the rectangle.
314 * @param remainder The left over part of the rectangle after slicing. 314 * @param[out] remainder The left over part of the rectangle after slicing.
315 * @param amount The slice location's vertical distance from the bottom. 315 * @param[in] amount The slice location's vertical distance from the bottom.
316 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise 316 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
317 * 317 *
318 * Cut a rectangle horizontally at a distance @p amount from the 318 * Cut a rectangle horizontally at a distance @p amount from the
@@ -324,10 +324,10 @@ static inline Eina_Bool eina_rectangle_y_cut(Eina_Rectangle *rect, Eina_Rectan
324/** 324/**
325 * @brief Slices a rectangle vertically starting from right edge. 325 * @brief Slices a rectangle vertically starting from right edge.
326 * 326 *
327 * @param rect The rectangle to slice. 327 * @param[in] rect The rectangle to slice.
328 * @param slice The sliced part of the rectangle. 328 * @param[out] slice The sliced part of the rectangle.
329 * @param remainder The left over part of the rectangle after slicing. 329 * @param[out] remainder The left over part of the rectangle after slicing.
330 * @param amount The slice location's horizontal distance from the right. 330 * @param[in] amount The slice location's horizontal distance from the right.
331 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise 331 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise
332 * 332 *
333 * Cut a rectangle vertically at a distance @p amount from the 333 * Cut a rectangle vertically at a distance @p amount from the
@@ -339,10 +339,10 @@ static inline Eina_Bool eina_rectangle_width_cut(Eina_Rectangle *rect, Eina_Re
339/** 339/**
340 * @brief Slices a rectangle horizontally starting from top edge. 340 * @brief Slices a rectangle horizontally starting from top edge.
341 * 341 *
342 * @param rect The rectangle to slice. 342 * @param[in] rect The rectangle to slice.
343 * @param slice The sliced part of the rectangle. 343 * @param[out] slice The sliced part of the rectangle.
344 * @param remainder The left over part of the rectangle after slicing. 344 * @param[out] remainder The left over part of the rectangle after slicing.
345 * @param amount The slice location's vertical distance from the top. 345 * @param[in] amount The slice location's vertical distance from the top.
346 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise. 346 * @return #EINA_TRUE if the cut succeeds, #EINA_FALSE otherwise.
347 * 347 *
348 * Cut a rectangle horizontally at a distance @p amount from the 348 * Cut a rectangle horizontally at a distance @p amount from the
@@ -354,9 +354,9 @@ static inline Eina_Bool eina_rectangle_height_cut(Eina_Rectangle *rect, Eina_R
354/** 354/**
355 * @brief Subtracts two rectangles and returns the differences. 355 * @brief Subtracts two rectangles and returns the differences.
356 * 356 *
357 * @param rect The minuend rectangle. 357 * @param[in] rect The minuend rectangle.
358 * @param other The subtrahend rectangle. 358 * @param[in] other The subtrahend rectangle.
359 * @param out An array of differences between the two rectangles. 359 * @param[out] out An array of differences between the two rectangles.
360 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 360 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
361 * 361 *
362 * This function subtracts two rectangles and stores the resulting 362 * This function subtracts two rectangles and stores the resulting
@@ -368,8 +368,8 @@ static inline Eina_Bool eina_rectangle_subtract(Eina_Rectangle *rect, Eina_Rec
368/** 368/**
369 * @brief Adds a rectangle in a new pool. 369 * @brief Adds a rectangle in a new pool.
370 * 370 *
371 * @param w The width of the rectangle. 371 * @param[in] w The width of the rectangle.
372 * @param h The height of the rectangle. 372 * @param[in] h The height of the rectangle.
373 * @return A newly allocated pool on success, @c NULL otherwise. 373 * @return A newly allocated pool on success, @c NULL otherwise.
374 * 374 *
375 * This function adds the rectangle of size (@p width, @p height) to a 375 * This function adds the rectangle of size (@p width, @p height) to a
@@ -381,7 +381,7 @@ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_new(int w, int h) EINA_MALLOC EINA
381/** 381/**
382 * @brief Returns the pool of the given rectangle. 382 * @brief Returns the pool of the given rectangle.
383 * 383 *
384 * @param rect The rectangle. 384 * @param[in] rect The rectangle.
385 * @return The pool of the given rectangle. 385 * @return The pool of the given rectangle.
386 * 386 *
387 * This function returns the pool in which @p rect is. If @p rect is 387 * This function returns the pool in which @p rect is. If @p rect is
@@ -392,9 +392,9 @@ EAPI Eina_Rectangle_Pool *eina_rectangle_pool_get(Eina_Rectangle *rect) EINA_WAR
392/** 392/**
393 * @brief Returns the width and height of the given pool. 393 * @brief Returns the width and height of the given pool.
394 * 394 *
395 * @param pool The pool. 395 * @param[in] pool The pool.
396 * @param w The returned width. 396 * @param[out] w The returned width.
397 * @param h The returned height. 397 * @param[out] h The returned height.
398 * @return #EINA_TRUE on success, #EINA_FALSE otherwise. 398 * @return #EINA_TRUE on success, #EINA_FALSE otherwise.
399 * 399 *
400 * This function returns the width and height of @p pool and store 400 * This function returns the width and height of @p pool and store
@@ -407,7 +407,7 @@ EAPI Eina_Bool eina_rectangle_pool_geometry_get(Eina_Rectangle_Pool *
407/** 407/**
408 * @brief Gets the data from the given pool. 408 * @brief Gets the data from the given pool.
409 * 409 *
410 * @param pool The pool. 410 * @param[in] pool The pool.
411 * @return The returned data. 411 * @return The returned data.
412 * 412 *
413 * This function gets the data from @p pool set by 413 * This function gets the data from @p pool set by
@@ -419,8 +419,8 @@ EAPI void *eina_rectangle_pool_data_get(Eina_Rectangle_Pool *pool
419/** 419/**
420 * @brief Sets the data to the given pool. 420 * @brief Sets the data to the given pool.
421 * 421 *
422 * @param pool The pool. 422 * @param[in,out] pool The pool.
423 * @param data The data to set. 423 * @param[in] data The data to set.
424 * 424 *
425 * This function sets @p data to @p pool. If @p pool is @c NULL, this 425 * This function sets @p data to @p pool. If @p pool is @c NULL, this
426 * function does nothing. 426 * function does nothing.
@@ -430,7 +430,7 @@ EAPI void eina_rectangle_pool_data_set(Eina_Rectangle_Pool *pool
430/** 430/**
431 * @brief Frees the given pool. 431 * @brief Frees the given pool.
432 * 432 *
433 * @param pool The pool to free. 433 * @param[in] pool The pool to free.
434 * 434 *
435 * This function frees the allocated data of @p pool. If @p pool is 435 * This function frees the allocated data of @p pool. If @p pool is
436 * @c NULL, this function returned immediately. 436 * @c NULL, this function returned immediately.
@@ -440,7 +440,7 @@ EAPI void eina_rectangle_pool_free(Eina_Rectangle_Pool *pool) EI
440/** 440/**
441 * @brief Returns the number of rectangles in the given pool. 441 * @brief Returns the number of rectangles in the given pool.
442 * 442 *
443 * @param pool The pool. 443 * @param[in] pool The pool.
444 * @return The number of rectangles in the pool. 444 * @return The number of rectangles in the pool.
445 * 445 *
446 * This function returns the number of rectangles in @p pool. 446 * This function returns the number of rectangles in @p pool.
@@ -450,9 +450,9 @@ EAPI int eina_rectangle_pool_count(Eina_Rectangle_Pool *pool) E
450/** 450/**
451 * @brief Requests a rectangle of given size in the given pool. 451 * @brief Requests a rectangle of given size in the given pool.
452 * 452 *
453 * @param pool The pool. 453 * @param[in,out] pool The pool.
454 * @param w The width of the rectangle to request. 454 * @param[in] w The width of the rectangle to request.
455 * @param h The height of the rectangle to request. 455 * @param[in] h The height of the rectangle to request.
456 * @return The requested rectangle on success, @c NULL otherwise. 456 * @return The requested rectangle on success, @c NULL otherwise.
457 * 457 *
458 * This function retrieves from @p pool the rectangle of width @p w and 458 * This function retrieves from @p pool the rectangle of width @p w and
@@ -467,7 +467,7 @@ EAPI Eina_Rectangle *eina_rectangle_pool_request(Eina_Rectangle_Pool *pool,
467/** 467/**
468 * @brief Removes the given rectangle from the pool. 468 * @brief Removes the given rectangle from the pool.
469 * 469 *
470 * @param rect The rectangle to remove from the pool. 470 * @param[in,out] rect The rectangle to remove from the pool.
471 * 471 *
472 * This function removes @p rect from the pool. If @p rect is 472 * This function removes @p rect from the pool. If @p rect is
473 * @c NULL, the function returns immediately. Otherwise it removes @p 473 * @c NULL, the function returns immediately. Otherwise it removes @p
@@ -479,11 +479,11 @@ EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA
479 * @def EINA_RECTANGLE_SET 479 * @def EINA_RECTANGLE_SET
480 * @brief Definition for the macro to set the values of a #Eina_Rectangle. 480 * @brief Definition for the macro to set the values of a #Eina_Rectangle.
481 * 481 *
482 * @param Rectangle The rectangle. 482 * @param[out] Rectangle The rectangle.
483 * @param X The X coordinate of the top left corner of the rectangle. 483 * @param[in] X The X coordinate of the top left corner of the rectangle.
484 * @param Y The Y coordinate of the top left corner of the rectangle. 484 * @param[in] Y The Y coordinate of the top left corner of the rectangle.
485 * @param W The width of the rectangle. 485 * @param[in] W The width of the rectangle.
486 * @param H The height of the rectangle. 486 * @param[in] H The height of the rectangle.
487 * 487 *
488 * This macro set the values of @p Rectangle. @p X and @p Y are the 488 * This macro set the values of @p Rectangle. @p X and @p Y are the
489 * coordinates of the top left corner of @p Rectangle, @p W is its 489 * coordinates of the top left corner of @p Rectangle, @p W is its
@@ -503,10 +503,10 @@ EAPI void eina_rectangle_pool_release(Eina_Rectangle *rect) EINA
503/** 503/**
504 * @brief Creates a new rectangle. 504 * @brief Creates a new rectangle.
505 * 505 *
506 * @param x The X coordinate of the top left corner of the rectangle. 506 * @param[in] x The X coordinate of the top left corner of the rectangle.
507 * @param y The Y coordinate of the top left corner of the rectangle. 507 * @param[in] y The Y coordinate of the top left corner of the rectangle.
508 * @param w The width of the rectangle. 508 * @param[in] w The width of the rectangle.
509 * @param h The height of the rectangle. 509 * @param[in] h The height of the rectangle.
510 * @return The new rectangle on success, @ NULL otherwise. 510 * @return The new rectangle on success, @ NULL otherwise.
511 * 511 *
512 * This function creates a rectangle whose top left corner has the 512 * This function creates a rectangle whose top left corner has the
@@ -520,7 +520,7 @@ EAPI Eina_Rectangle *eina_rectangle_new(int x, int y, int w, int h) EINA_MALLOC
520/** 520/**
521 * @brief Frees the given rectangle. 521 * @brief Frees the given rectangle.
522 * 522 *
523 * @param rect The rectangle to free. 523 * @param[iin] rect The rectangle to free.
524 * 524 *
525 * This function removes @p rect from the rectangles pool. 525 * This function removes @p rect from the rectangles pool.
526 */ 526 */
@@ -529,8 +529,8 @@ EAPI void eina_rectangle_free(Eina_Rectangle *rect) EINA_ARG_NONNULL(
529/** 529/**
530 * @brief Sets the type of given rectangle pool. 530 * @brief Sets the type of given rectangle pool.
531 * 531 *
532 * @param pool The rectangle pool for which type is to be set. 532 * @param[in,out] pool The rectangle pool for which type is to be set.
533 * @param type Type of Eina Pool based on packing algorithm. 533 * @param[in] type Type of Eina Pool based on packing algorithm.
534 * 534 *
535 * This function sets @p type of @p pool. 535 * This function sets @p type of @p pool.
536 * @see Eina_Rectangle_Packing 536 * @see Eina_Rectangle_Packing
@@ -541,8 +541,8 @@ EAPI void eina_rectangle_pool_packing_set(Eina_Rectangle_Pool *pool,E
541/** 541/**
542 * @brief calculates where rect2 is outside of rect1. 542 * @brief calculates where rect2 is outside of rect1.
543 * 543 *
544 * @param rect1 The rect to use as anchor 544 * @param[in] rect1 The rect to use as anchor
545 * @param rect2 The rect to look for outside positions 545 * @param[in] rect2 The rect to look for outside positions
546 * 546 *
547 * @return An OR'd map of Eina_Rectangle_Outside values 547 * @return An OR'd map of Eina_Rectangle_Outside values
548 * @since 1.19 548 * @since 1.19
@@ -552,8 +552,8 @@ EAPI Eina_Rectangle_Outside eina_rectangle_outside_position(Eina_Rectangle *rect
552/** 552/**
553 * @brief Compares two rectangles for equality 553 * @brief Compares two rectangles for equality
554 * 554 *
555 * @param rect1 First rectangle. Must not be NULL. 555 * @param[in] rect1 First rectangle. Must not be NULL.
556 * @param rect2 Second rectangle. Must not be NULL. 556 * @param[in] rect2 Second rectangle. Must not be NULL.
557 * @return EINA_TRUE if the rectangles are equal (x, y, w and h are all equal). 557 * @return EINA_TRUE if the rectangles are equal (x, y, w and h are all equal).
558 * 558 *
559 * No check is made on the rectangles, so they should be valid and non 559 * No check is made on the rectangles, so they should be valid and non