Added more documentation for 'struct UserSettings' (#417)

DerjenigeUberMensch · Sep 1, 2024 · 028a5ea · 028a5ea
1 parent c3743d7
commit 028a5ea
Showing 1 changed file with 6 additions and 7 deletions.
diff --git a/include/settings.h b/include/settings.h
@@ -48,15 +48,14 @@ struct BarSettings
 
 struct UserSettings
 {
-    float mfact;
-    float gapratio;
-
-    uint16_t mcount;        /* tiling master count */
-    uint16_t snap;
-    uint16_t refreshrate;
+    float mfact;            /* factor of master area size [0.05..0.95]                          */
+    float gapratio;         /* invisible border pixel of windows (CFG_BORDER_PX not affected)   */
+    uint16_t mcount;        /* number of clients in master area                                 */
+    uint16_t snap;          /* snap window to border in pixels; 0 to disable (NOT RECOMMENDED)  */
+    uint16_t refreshrate;   /* max refresh rate when resizing, moving windows;  0 to disable    */
 
     uint16_t flags;
-    uint16_t maxcc;
+    uint16_t maxcc;         /* max number of clients (XOrg Default is 256)                      */
 
     /* bar stuff */
     BarSettings bar;