diff --git a/docs/comlink.lua b/docs/comlink.lua index 2792eab..bb33f40 100644 --- a/docs/comlink.lua +++ b/docs/comlink.lua @@ -86,16 +86,21 @@ function comlink.selected_channel() end ---@class Channel local channel = {} ----Send a message to the channel. If the message begins with a '/', it will be processed as a command. This allows for sending of "/me " style messages from lua ---- ----@param chan Channel this channel ----@param msg string message to send -function channel.send_msg(chan, msg) end - ---Get the name of the channel --- ---@param chan Channel // this channel ---@return string name name of the channel function channel.name(chan) end +---Mark a channel as read +--- +---@param chan Channel // this channel +function channel.mark_read(chan) end + +---Send a message to the channel. If the message begins with a '/', it will be processed as a command. This allows for sending of "/me " style messages from lua +--- +---@param chan Channel this channel +---@param msg string message to send +function channel.send_msg(chan, msg) end + return comlink diff --git a/docs/comlink_channel.3.scd b/docs/comlink_channel.3.scd index f66c05e..02b8ff5 100644 --- a/docs/comlink_channel.3.scd +++ b/docs/comlink_channel.3.scd @@ -10,12 +10,18 @@ comlink_channel - a lua type representing an IRC channel *local name = channel:name*() +*channel:mark_read*() + *channel:send_msg*(_msg_) # DESCRIPTION A *channel* represents an IRC channel. +*channel:mark_read* + Mark this channel as read. This will set the READMARKER to the time of + the last received message. + *channel:send_msg* A method on *channel* which accepts a string (_msg_). _Msg_ is sent to the *channel* using a *PRIVMSG* IRC command. Note that this is a method