screen: Add more documentation

This commit is contained in:
Emmanuel Lepage Vallee 2016-04-04 04:02:46 -04:00
parent eb133175ba
commit 1bbdbc7053
1 changed files with 16 additions and 0 deletions

View File

@ -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}.