diff options
author | Adrian Johnson <ajohnson@redneon.com> | 2023-01-27 10:26:44 +0000 |
---|---|---|
committer | Adrian Johnson <ajohnson@redneon.com> | 2023-01-27 10:26:44 +0000 |
commit | 22d0cd1ec3f41c04d242ba775d4eb1693aca8c14 (patch) | |
tree | cfcb6db86d1966488ad53b0b14aef0049dcdea78 /src | |
parent | 119ce21b2c8f5baae614eea5e11ab87efd6ecdf2 (diff) | |
parent | f05f2b3955ac77b55a1b8ffd2c2ccd5659a7da1e (diff) | |
download | cairo-22d0cd1ec3f41c04d242ba775d4eb1693aca8c14.tar.gz |
Merge branch 'doc-fixes' into 'master'
Some documentation fixes
See merge request cairo/cairo!428
Diffstat (limited to 'src')
-rw-r--r-- | src/cairo-boxes.c | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/src/cairo-boxes.c b/src/cairo-boxes.c index 3c5d2a750..383a3eefb 100644 --- a/src/cairo-boxes.c +++ b/src/cairo-boxes.c @@ -102,16 +102,16 @@ _cairo_boxes_init_for_array (cairo_boxes_t *boxes, boxes->is_pixel_aligned = n == num_boxes; } -/** _cairo_boxes_limit: +/** + * _cairo_boxes_limit: + * @boxes: the box set to be filled (return buffer) + * @limits: array of the limiting boxes to compute the bounding + * box from + * @num_limits: length of the limits array * * Computes the minimum bounding box of the given list of boxes and assign * it to the given boxes set. It also assigns that list as the list of * limiting boxes in the box set. - * - * @param boxes the box set to be filled (return buffer) - * @param limits array of the limiting boxes to compute the bounding - * box from - * @param num_limits length of the limits array */ void _cairo_boxes_limit (cairo_boxes_t *boxes, @@ -276,13 +276,13 @@ _cairo_boxes_add (cairo_boxes_t *boxes, return boxes->status; } -/** _cairo_boxes_extents: +/** + * _cairo_boxes_extents: + * @boxes: The box set whose minimum bounding is computed. + * @box: Return buffer for the computed result. * * Computes the minimum bounding box of the given box set and stores * it in the given box. - * - * @param boxes The box set whose minimum bounding is computed. - * @param box Return buffer for the computed result. */ void _cairo_boxes_extents (const cairo_boxes_t *boxes, @@ -336,15 +336,16 @@ _cairo_boxes_clear (cairo_boxes_t *boxes) boxes->is_pixel_aligned = TRUE; } -/** _cairo_boxes_to_array: +/** + * _cairo_boxes_to_array: + * @boxes The box set to be converted. + * @num_boxes Return buffer for the number of boxes (array count). * * Linearize a box set of possibly multiple chunks into one big chunk * and returns an array of boxes * - * @param boxes The box set to be converted. - * @param num_boxes Return buffer for the number of boxes (array count). - * @return Pointer to the newly allocated array of boxes - * (the number o elements is given in num_boxes). + * Return value: Pointer to the newly allocated array of boxes (the number o + * elements is given in num_boxes). */ cairo_box_t * _cairo_boxes_to_array (const cairo_boxes_t *boxes, |