Fix spelling errors in luadoc
Signed-off-by: Brian Gianforcaro <b.gianfo@gmail.com> Signed-off-by: Julien Danjou <julien@danjou.info>
This commit is contained in:
parent
59c4e46e3f
commit
b5cef4c1e0
|
@ -12,7 +12,7 @@ module("button")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -45,7 +45,7 @@ module("client")
|
||||||
-- @name client
|
-- @name client
|
||||||
|
|
||||||
--- Get all clients into a table.
|
--- Get all clients into a table.
|
||||||
-- @param screen An optional screen nunmber.
|
-- @param screen An optional screen number.
|
||||||
-- @return A table with all clients.
|
-- @return A table with all clients.
|
||||||
-- @name client.get
|
-- @name client.get
|
||||||
-- @class function
|
-- @class function
|
||||||
|
@ -118,7 +118,7 @@ module("client")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name client.add_signal
|
-- @name client.add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ module("image")
|
||||||
--- Image objects.
|
--- Image objects.
|
||||||
-- @field width The image width. Immutable.
|
-- @field width The image width. Immutable.
|
||||||
-- @field height The image height. Immutable.
|
-- @field height The image height. Immutable.
|
||||||
-- @field alpha Boolean indiacating if the image alpha channel is present.
|
-- @field alpha Boolean indicating if the image alpha channel is present.
|
||||||
-- @class table
|
-- @class table
|
||||||
-- @name image
|
-- @name image
|
||||||
|
|
||||||
|
@ -113,7 +113,7 @@ module("image")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ module("key")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -8,7 +8,7 @@ module("keygrabber")
|
||||||
-- continue grabbing, false to stop.
|
-- continue grabbing, false to stop.
|
||||||
-- The function is called with 3 arguments:
|
-- The function is called with 3 arguments:
|
||||||
-- a table containing modifiers keys, a string with the key pressed and a
|
-- a table containing modifiers keys, a string with the key pressed and a
|
||||||
-- string with eithe "press" or "release" to indicate the event type.
|
-- string with either "press" or "release" to indicate the event type.
|
||||||
-- @param func A callback function as described above.
|
-- @param func A callback function as described above.
|
||||||
-- @name run
|
-- @name run
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
|
@ -3,8 +3,8 @@
|
||||||
-- @copyright 2008-2009 Julien Danjou
|
-- @copyright 2008-2009 Julien Danjou
|
||||||
module("screen")
|
module("screen")
|
||||||
|
|
||||||
--- Scree is a table where indexes are screen number. You can use screen[1] to get acces to the
|
--- Screen is a table where indexes are screen number. You can use screen[1]
|
||||||
-- first screen, etc. Each screen has a set of properties.
|
-- to get access to the first screen, etc. 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.
|
||||||
|
@ -19,7 +19,7 @@ module("screen")
|
||||||
|
|
||||||
--- Add a signal to a screen.
|
--- Add a signal to a screen.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -18,7 +18,7 @@ module("tag")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
-- @copyright 2009 Julien Danjou
|
-- @copyright 2009 Julien Danjou
|
||||||
module("timer")
|
module("timer")
|
||||||
|
|
||||||
--- Timer object. This type of objects is useful to trigger events in a repeated manner.
|
--- Timer object. This type of object is useful when triggering events in a repeatedly.
|
||||||
-- The timer will emit the "timeout" signal every N seconds, N being the timeout value.
|
-- The timer will emit the "timeout" signal every N seconds, N being the timeout value.
|
||||||
-- @field timeout Interval in seconds to emit the timeout signal.
|
-- @field timeout Interval in seconds to emit the timeout signal.
|
||||||
-- Can be any value, including floating ones (i.e. 1.5 second).
|
-- Can be any value, including floating ones (i.e. 1.5 second).
|
||||||
|
@ -23,7 +23,7 @@ module("timer")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -48,7 +48,7 @@ module("wibox")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
|
@ -51,7 +51,7 @@ module("widget")
|
||||||
|
|
||||||
--- Add a signal.
|
--- Add a signal.
|
||||||
-- @param name A signal name.
|
-- @param name A signal name.
|
||||||
-- @param func A function to call when the signal is emited.
|
-- @param func A function to call when the signal is emitted.
|
||||||
-- @name add_signal
|
-- @name add_signal
|
||||||
-- @class function
|
-- @class function
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue