diff options
author | jluehrs2 <jluehrs2@uiuc.edu> | 2007-09-02 14:00:54 -0500 |
---|---|---|
committer | jluehrs2 <jluehrs2@uiuc.edu> | 2007-09-02 14:00:54 -0500 |
commit | 4bdb3752996643790031892b6cba368a4c2d1ee5 (patch) | |
tree | 9fcc3fc172a302d831bf6643cf75ef67c7dc877f | |
parent | f251f4114f28af6a35a5dafb32a24ac9e9f7cefd (diff) | |
download | luairc-4bdb3752996643790031892b6cba368a4c2d1ee5.tar.gz luairc-4bdb3752996643790031892b6cba368a4c2d1ee5.zip |
document the misc functions
-rw-r--r-- | src/irc.lua | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/src/irc.lua b/src/irc.lua index 4a21a96..423ad64 100644 --- a/src/irc.lua +++ b/src/irc.lua @@ -881,11 +881,16 @@ end -- }}} -- misc functions {{{ --- send() - send a raw irc command {{{ --- send takes a command and a variable number of arguments --- if the argument is a string, it is sent literally --- if the argument is a table, it is CTCP quoted --- the last argument is preceded by a : +-- TODO: CTCP quoting should be explicit, this table thing is quite ugly (if +-- convenient) +-- send {{{ +--- +-- Send a raw IRC command. +-- @param command String containing the raw IRC command +-- @param ... Arguments to the command. Each argument is either a string or +-- an array. Strings are sent literally, arrays are CTCP quoted +-- as a group. The last argument (if it exists) is preceded by +-- a : (so it may contain spaces). function send(command, ...) if not serverinfo.connected and not serverinfo.connecting then return end local message = command @@ -911,13 +916,23 @@ function send(command, ...) end -- }}} --- get_ip() - get the local ip address for the server connection {{{ +-- get_ip {{{ +--- +-- Get the local IP address for the server connection. +-- @return A string representation of the local IP address that the IRC server +-- connection is communicating on function get_ip() return (irc_sock:getsockname()) end -- }}} --- channels() - iterate over currently joined channels {{{ +-- channels {{{ +-- TODO: @see doesn't currently work for files/modules +--- +-- Iterate over currently joined channels. +-- channels() is an iterator function for use in for loops. +-- For example, <pre>for chan in irc.channels() do print(chan:name) end</pre> +-- @see src/irc/channel.lua function channels() return function(state, arg) return misc.value_iter(state, arg, |