summaryrefslogtreecommitdiff
path: root/src/cairo-boxes.c
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2017-12-07 14:00:21 -0800
committerBryce Harrington <bryce@osg.samsung.com>2017-12-07 14:13:32 -0800
commit04b4967586ac31763186d9894107b8c8403bcb34 (patch)
tree26ad0a156b2499918c312a4b904103f6140d7352 /src/cairo-boxes.c
parentdbc1636a9b932fd81ace436a03c1992a6ac1cbcf (diff)
downloadcairo-04b4967586ac31763186d9894107b8c8403bcb34.tar.gz
Fix various doxygen warnings found by check-doc-syntax.sh
./cairo-clip-boxes.c (268): ERROR: copy invalid doc id (should be 'cairo_...:') ./cairo-clip-boxes.c (274): ERROR: copy bad line: ' */' ./cairo-clip-boxes.c (274): ERROR: copy documentation comment not closed with **/ ./cairo-boxes.c (106): ERROR: Computes invalid doc id (should be 'cairo_...:') ./cairo-boxes.c (114): ERROR: Computes bad line: ' */' ./cairo-boxes.c (114): ERROR: Computes documentation comment not closed with **/ ./cairo-boxes.c (279): ERROR: Computes invalid doc id (should be 'cairo_...:') ./cairo-boxes.c (284): ERROR: Computes bad line: ' */' ./cairo-boxes.c (284): ERROR: Computes documentation comment not closed with **/ ./cairo-boxes.c (338): ERROR: Linearize invalid doc id (should be 'cairo_...:') ./cairo-boxes.c (345): ERROR: Linearize documentation comment not closed with **/ ./cairo.c (240): ERROR: SECTION:cairo-tag bad line: '' ./cairo.c (892): ERROR: cairo_set_source_rgb: Duplicate 'Since' field
Diffstat (limited to 'src/cairo-boxes.c')
-rw-r--r--src/cairo-boxes.c23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/cairo-boxes.c b/src/cairo-boxes.c
index 6ddf81a82..3c5d2a750 100644
--- a/src/cairo-boxes.c
+++ b/src/cairo-boxes.c
@@ -102,7 +102,8 @@ _cairo_boxes_init_for_array (cairo_boxes_t *boxes,
boxes->is_pixel_aligned = n == num_boxes;
}
-/**
+/** _cairo_boxes_limit:
+ *
* 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.
@@ -275,12 +276,13 @@ _cairo_boxes_add (cairo_boxes_t *boxes,
return boxes->status;
}
-/**
+/** _cairo_boxes_extents:
+ *
* 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
+ * @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,
@@ -334,15 +336,16 @@ _cairo_boxes_clear (cairo_boxes_t *boxes)
boxes->is_pixel_aligned = TRUE;
}
-/**
+/** _cairo_boxes_to_array:
+ *
* 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)
- * */
+ * @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).
+ */
cairo_box_t *
_cairo_boxes_to_array (const cairo_boxes_t *boxes,
int *num_boxes)