From b5cef4c1e0eb621245a16f29d5c30dce98e8497f Mon Sep 17 00:00:00 2001 From: Brian Gianforcaro Date: Sun, 30 Aug 2009 00:20:52 -0400 Subject: [PATCH] Fix spelling errors in luadoc Signed-off-by: Brian Gianforcaro Signed-off-by: Julien Danjou --- luadoc/button.lua | 2 +- luadoc/client.lua | 4 ++-- luadoc/image.lua | 4 ++-- luadoc/key.lua | 2 +- luadoc/keygrabber.lua | 2 +- luadoc/screen.lua | 6 +++--- luadoc/tag.lua | 2 +- luadoc/timer.lua | 4 ++-- luadoc/wibox.lua | 2 +- luadoc/widget.lua | 2 +- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/luadoc/button.lua b/luadoc/button.lua index a2b8d8f7..5adeb3fc 100644 --- a/luadoc/button.lua +++ b/luadoc/button.lua @@ -12,7 +12,7 @@ module("button") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/client.lua b/luadoc/client.lua index b8c15e05..92cd94f8 100644 --- a/luadoc/client.lua +++ b/luadoc/client.lua @@ -45,7 +45,7 @@ module("client") -- @name client --- Get all clients into a table. --- @param screen An optional screen nunmber. +-- @param screen An optional screen number. -- @return A table with all clients. -- @name client.get -- @class function @@ -118,7 +118,7 @@ module("client") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/image.lua b/luadoc/image.lua index e4d369c0..834d2ed2 100644 --- a/luadoc/image.lua +++ b/luadoc/image.lua @@ -6,7 +6,7 @@ module("image") --- Image objects. -- @field width The image width. 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 -- @name image @@ -113,7 +113,7 @@ module("image") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/key.lua b/luadoc/key.lua index 5d2eb3cf..d166ad9a 100644 --- a/luadoc/key.lua +++ b/luadoc/key.lua @@ -15,7 +15,7 @@ module("key") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/keygrabber.lua b/luadoc/keygrabber.lua index ccb009d9..eb041f05 100644 --- a/luadoc/keygrabber.lua +++ b/luadoc/keygrabber.lua @@ -8,7 +8,7 @@ module("keygrabber") -- continue grabbing, false to stop. -- The function is called with 3 arguments: -- 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. -- @name run -- @class function diff --git a/luadoc/screen.lua b/luadoc/screen.lua index cb8b828d..488a3b45 100644 --- a/luadoc/screen.lua +++ b/luadoc/screen.lua @@ -3,8 +3,8 @@ -- @copyright 2008-2009 Julien Danjou module("screen") ---- Scree is a table where indexes are screen number. You can use screen[1] to get acces to the --- first screen, etc. Each screen has a set of properties. +--- 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. -- @field geometry The screen coordinates. Immutable. -- @field workarea The screen workarea. -- @field index The screen number. @@ -19,7 +19,7 @@ module("screen") --- Add a signal to a screen. -- @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 -- @class function diff --git a/luadoc/tag.lua b/luadoc/tag.lua index 5ec14f1f..a6776cc6 100644 --- a/luadoc/tag.lua +++ b/luadoc/tag.lua @@ -18,7 +18,7 @@ module("tag") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/timer.lua b/luadoc/timer.lua index 89cac2d1..d41baaae 100644 --- a/luadoc/timer.lua +++ b/luadoc/timer.lua @@ -3,7 +3,7 @@ -- @copyright 2009 Julien Danjou 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. -- @field timeout Interval in seconds to emit the timeout signal. -- Can be any value, including floating ones (i.e. 1.5 second). @@ -23,7 +23,7 @@ module("timer") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/wibox.lua b/luadoc/wibox.lua index 6bf66f84..5b88a211 100644 --- a/luadoc/wibox.lua +++ b/luadoc/wibox.lua @@ -48,7 +48,7 @@ module("wibox") --- Add a signal. -- @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 -- @class function diff --git a/luadoc/widget.lua b/luadoc/widget.lua index e7f40c79..e3a10baa 100644 --- a/luadoc/widget.lua +++ b/luadoc/widget.lua @@ -51,7 +51,7 @@ module("widget") --- Add a signal. -- @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 -- @class function