luadoc: Document screen outputs

This was introduced in 2009, commits 9393b2d1 and c08b9034.

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2013-10-31 10:31:54 +01:00
parent 8125cda2a8
commit 29ecc6095f
1 changed files with 5 additions and 1 deletions

View File

@ -4,10 +4,14 @@
module("screen") module("screen")
--- Screen is a table where indexes are screen number. You can use screen[1] --- Screen is a table where indexes are screen number. You can use screen[1]
-- to get access to the first screen, etc. Each screen has a set of properties. -- to get access to the first screen, etc. Alternatively, if RANDR information
-- is available, you can use output names for finding screen objects.
-- Each screen has a set of properties.
-- @field geometry The screen coordinates. Immutable. -- @field geometry The screen coordinates. Immutable.
-- @field workarea The screen workarea. -- @field workarea The screen workarea.
-- @field index The screen number. -- @field index The screen number.
-- @field outputs If RANDR information is available, a list of outputs for this
-- screen and their size in mm.
-- @class table -- @class table
-- @name screen -- @name screen