From: Ingo Bürk <ingo.buerk@tngtech.com>
Date: Sat, 21 Nov 2015 20:52:43 +0000 (+0100)
Subject: Document rect, window_rect and deco_rect.
X-Git-Tag: 4.12~101^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=8016cce44755d3b37ce66e0fd8bec560b3c71178;p=i3%2Fi3

Document rect, window_rect and deco_rect.
---

diff --git a/include/data.h b/include/data.h
index 3a752c2e..e5a76462 100644
--- a/include/data.h
+++ b/include/data.h
@@ -572,8 +572,14 @@ struct Con {
 
     struct Con *parent;
 
+    /* The position and size for this con. These coordinates are absolute. Note
+     * that the rect of a container does not include the decoration. */
     struct Rect rect;
+    /* The position and size of the actual client window. These coordinates are
+     * relative to the container's rect. */
     struct Rect window_rect;
+    /* The position and size of the container's decoration. These coordinates
+     * are relative to the container's parent's rect. */
     struct Rect deco_rect;
     /** the geometry this window requested when getting mapped */
     struct Rect geometry;