[cairo-commit] 3 commits - doc/public src/cairo-boxes.c

[GitLab Mirror]

 doc/public/cairo-docs.xml |   24 +++++++++++++++---------
 src/cairo-boxes.c         |   31 ++++++++++++++++---------------
 2 files changed, 31 insertions(+), 24 deletions(-)

New commits:
commit 22d0cd1ec3f41c04d242ba775d4eb1693aca8c14
Merge: 119ce21b2 f05f2b395
Author: Adrian Johnson <ajohnson at redneon.com>
Date:   Fri Jan 27 10:26:44 2023 +0000

    Merge branch 'doc-fixes' into 'master'
    
    Some documentation fixes
    
    See merge request cairo/cairo!428

commit f05f2b3955ac77b55a1b8ffd2c2ccd5659a7da1e
Author: Khaled Hosny <khaled at aliftype.com>
Date:   Thu Jan 26 14:09:08 2023 +0200

    Fix gtk-doc syntax

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,
commit 3cea38c02c0b04409069f19614d08e7850730905
Author: Khaled Hosny <khaled at aliftype.com>
Date:   Thu Jan 26 13:39:36 2023 +0200

    doc: fix generation of API indices
    
    The index id is expected to be "api-index-*" not just "index-*", and for
    some reason newer versions of gtk-doc don’t like these "role" attributes
    and will not generate the index if they are present. Also add missing
    indices for 1.0 and 1.18.

diff --git a/doc/public/cairo-docs.xml b/doc/public/cairo-docs.xml
index b5afa1b90..0a0e462f9 100644
--- a/doc/public/cairo-docs.xml
+++ b/doc/public/cairo-docs.xml
@@ -56,32 +56,38 @@
     <xi:include href="xml/cairo-version.xml"/>
     <xi:include href="xml/cairo-types.xml"/>
   </chapter>
-  <index id="index-all">
+  <index id="api-index-all">
     <title>Index</title>
   </index>
-  <index id="index-1.2" role="1.2">
+  <index id="api-index-1.0">
+    <title>Index of new symbols in 1.0</title>
+  </index>
+  <index id="api-index-1.2">
     <title>Index of new symbols in 1.2</title>
   </index>
-  <index id="index-1.4" role="1.4">
+  <index id="api-index-1.4">
     <title>Index of new symbols in 1.4</title>
   </index>
-  <index id="index-1.6" role="1.6">
+  <index id="api-index-1.6">
     <title>Index of new symbols in 1.6</title>
   </index>
-  <index id="index-1.8" role="1.8">
+  <index id="api-index-1.8">
     <title>Index of new symbols in 1.8</title>
   </index>
-  <index id="index-1.10" role="1.10">
+  <index id="api-index-1.10">
     <title>Index of new symbols in 1.10</title>
   </index>
-  <index id="index-1.12" role="1.12">
+  <index id="api-index-1.12">
     <title>Index of new symbols in 1.12</title>
   </index>
-  <index id="index-1.14" role="1.14">
+  <index id="api-index-1.14">
     <title>Index of new symbols in 1.14</title>
   </index>
-  <index id="index-1.16" role="1.16">
+  <index id="api-index-1.16">
     <title>Index of new symbols in 1.16</title>
   </index>
+  <index id="api-index-1.18">
+    <title>Index of new symbols in 1.18</title>
+  </index>
   <xi:include href="language-bindings.xml"/>
 </book>