doc: fix typos and add type information to screen module

This commit is contained in:
Daniel Hahler 2015-02-22 23:57:11 +01:00
parent f8a3209707
commit a533097cfd
1 changed files with 12 additions and 12 deletions

View File

@ -4,37 +4,37 @@
-- @release @AWESOME_VERSION@ -- @release @AWESOME_VERSION@
-- @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 numbers. You can use `screen[1]`
-- to get access to the first screen, etc. Alternatively, if RANDR information -- to get access to the first screen, etc. Alternatively, if RANDR information
-- is available, you can use output names for finding screen objects. -- is available, you can use output names for finding screen objects.
-- Each screen has a set of properties. -- Each screen has a set of properties.
-- --
-- @field geometry The screen coordinates. Immutable. -- @tfield table geometry The screen coordinates. Immutable.
-- @field workarea The screen workarea. -- @tfield table workarea The screen workarea.
-- @field index The screen number. -- @tfield int index The screen number.
-- @field outputs If RANDR information is available, a list of outputs for this -- @tfield table outputs If RANDR information is available, a list of outputs
-- screen and their size in mm. -- for this screen and their size in mm.
-- @table screen -- @table screen
--- Get the number of screen. --- Get the number of screens.
-- --
-- @return The screen count, at least 1. -- @return The screen count, at least 1.
-- @function count -- @function count
--- Add a signal to a screen. --- Add a signal to a screen.
-- --
-- @param name A signal name. -- @string name A signal name.
-- @param func A function to call when the signal is emitted. -- @func func A function to call when the signal is emitted.
-- @function connect_signal -- @function connect_signal
--- Remove a signal to a screen. --- Remove a signal to a screen.
-- --
-- @param name A signal name. -- @string name A signal name.
-- @param func A function to remove -- @func func A function to remove
-- @function disconnect_signal -- @function disconnect_signal
--- Emit a signal to a screen. --- Emit a signal to a screen.
-- --
-- @param name A signal name. -- @string name A signal name.
-- @param ... Various arguments, optional. -- @param ... Various arguments, optional.
-- @function emit_signal -- @function emit_signal