From 1bbdbc7053c40eab1eaa8c5c49132149bb9d35c0 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <elv1313@gmail.com>
Date: Mon, 4 Apr 2016 04:02:46 -0400
Subject: [PATCH] screen: Add more documentation

---
 objects/screen.c | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/objects/screen.c b/objects/screen.c
index 934557154..1d2882cba 100644
--- a/objects/screen.c
+++ b/objects/screen.c
@@ -20,6 +20,22 @@
  */
 
 /** awesome screen API
+ *
+ * Screen objects can be added and removed over time. To get a callback for all
+ * current and future screens, use `awful.screen.connect_for_each_screen`:
+ *
+ *    awful.screen.connect_for_each_screen(function(s)
+ *        -- do something
+ *    end)
+ *
+ * It is also possible loop over all current screens using:
+ *
+ *    for s, screen do
+ *        -- do something
+ *    end
+ *
+ * Most basic Awesome objects also have a screen property, see `mouse.screen`
+ * `client.screen`, `wibox.screen` and `tag.screen`.
  *
  * Furthermore to the classes described here, one can also use signals as
  * described in @{signals}.