add missing documentation for some rectangle creation parameters

Tue, 05 Aug 2025 16:53:25 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 05 Aug 2025 16:53:25 +0200
changeset 252
42e8695372f7
parent 251
2e2d4c3bf1cd
child 253
6ab35fcb8676

add missing documentation for some rectangle creation parameters

src/ascension/2d.h file | annotate | diff | comparison | revisions
--- a/src/ascension/2d.h	Tue Aug 05 16:48:04 2025 +0200
+++ b/src/ascension/2d.h	Tue Aug 05 16:53:25 2025 +0200
@@ -43,11 +43,35 @@
 } AscRectangle;
 
 struct asc_rectangle_create_args {
+    /**
+     * X-coordinate of the rectangle's origin.
+     * When no alternate point of origin is specified, the (x,y) belongs to the top-left corner.
+     */
     int x;
+    /**
+     * Y-coordinate of the rectangle's origin.
+     * When no alternate point of origin is specified, the (x,y) belongs to the top-left corner.
+     */
     int y;
+    /**
+     * X-offset for the point of origin in rectangle coordinates.
+     * Zero means the left edge and the rectangle's width means the right edge.
+     * The origin may lie outside the rectangle's bounds.
+     */
     int origin_x;
+    /**
+     * Y-offset for the point of origin in rectangle coordinates.
+     * Zero means the top edge and the rectangle's height means the bottom edge.
+    * The origin may lie outside the rectangle's bounds.
+     */
     int origin_y;
+    /**
+     * The horizontal length of the rectangle.
+     */
     unsigned int width;
+    /**
+     * The vertical length of the rectangle.
+     */
     unsigned int height;
     /**
      * Corner radius.

mercurial