Fix some broken luadoc

Signed-off-by: Uli Schlachter <psychon@znc.in>
This commit is contained in:
Uli Schlachter 2010-09-29 21:38:06 +02:00
parent db3b1fe431
commit ad3e965e16
2 changed files with 6 additions and 6 deletions

View File

@ -18,7 +18,7 @@ local function check(obj)
end end
end end
-- Find a given signal --- Find a given signal
-- @param obj The object to search in -- @param obj The object to search in
-- @param name The signal to find -- @param name The signal to find
-- @param error_msg Error message for if the signal is not found -- @param error_msg Error message for if the signal is not found
@ -31,7 +31,7 @@ local function find_signal(obj, name, error_msg)
return obj._signals[name] return obj._signals[name]
end end
-- Add a signal to an object. All signals must be added before they can be used. --- Add a signal to an object. All signals must be added before they can be used.
-- @param obj The object -- @param obj The object
-- @param name The name of the new signal. -- @param name The name of the new signal.
function add_signal(obj, name) function add_signal(obj, name)
@ -41,7 +41,7 @@ function add_signal(obj, name)
end end
end end
-- Connect to a signal --- Connect to a signal
-- @param obj The object -- @param obj The object
-- @param name The name of the signal -- @param name The name of the signal
-- @param func The callback to call when the signal is emitted -- @param func The callback to call when the signal is emitted
@ -50,7 +50,7 @@ function connect_signal(obj, name, func)
sig[func] = func sig[func] = func
end end
-- Disonnect to a signal --- Disonnect to a signal
-- @param obj The object -- @param obj The object
-- @param name The name of the signal -- @param name The name of the signal
-- @param func The callback that should be disconnected -- @param func The callback that should be disconnected
@ -59,7 +59,7 @@ function disconnect_signal(obj, name, func)
sig[func] = nil sig[func] = nil
end end
-- Emit a signal --- Emit a signal
-- @param obj The object -- @param obj The object
-- @param name The name of the signal -- @param name The name of the signal
-- @param ... Extra arguments for the callback functions. Each connected -- @param ... Extra arguments for the callback functions. Each connected

View File

@ -15,7 +15,7 @@ local function less_than_comp(a, b)
return a < b return a < b
end end
-- Sort a table. This interface should be identical to table.sort(). --- Sort a table. This interface should be identical to table.sort().
-- The difference to table.sort() is that this sort is stable. -- The difference to table.sort() is that this sort is stable.
-- @param list The table to sort (we do an in-place sort!). -- @param list The table to sort (we do an in-place sort!).
-- @param comp Comparator used for the sorting -- @param comp Comparator used for the sorting