diff --git a/doc/irc.luadoc b/doc/irc.luadoc index ddd7b76..1a98b88 100644 --- a/doc/irc.luadoc +++ b/doc/irc.luadoc @@ -44,10 +44,13 @@ function irc:hook(name, id, f) function irc:unhook(name, id) --- Connect irc to an IRC server. --- @param server Server address. +-- @param host Host address. -- @param port Server port. [default 6667] --- @param timeout Connection timeout value in seconds. [default 30] -function irc:connect(server, port, timeout) +function irc:connect(server, port) + +-- @param table Table of connection details +-- @see Connection +function irc:connect(table) --- Disconnect irc from the server. -- @param message Quit message. @@ -108,8 +111,21 @@ function irc:invoke(name, ...) function irc:handle(prefix, cmd, params) function irc:shutdown() +--- Table with connection information. +-- +-- [luasec]: http://www.inf.puc-rio.br/~brunoos/luasec/reference.html +-- @name Connection +-- @class table + --- List of hooks you can use with irc:hook. The parameter list describes the parameters passed to the callback function. -- -- * Event also invoked for yourself. -- † Channel passed only when user tracking is enabled