rockorager.dev
an experimental irc client
docs: update docs with mark_read method
+17
-6
+11
-6
docs/comlink.lua
+11
-6
docs/comlink.lua
···
86
86
---@class Channel
87
87
local channel = {}
88
88
89
+
---Get the name of the channel
90
+
---
91
+
---@param chan Channel // this channel
92
+
---@return string name name of the channel
93
+
function channel.name(chan) end
94
+
95
+
---Mark a channel as read
96
+
---
97
+
---@param chan Channel // this channel
98
+
function channel.mark_read(chan) end
99
+
89
100
---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 <msg>" style messages from lua
90
101
---
91
102
---@param chan Channel this channel
92
103
---@param msg string message to send
93
104
function channel.send_msg(chan, msg) end
94
-
95
-
---Get the name of the channel
96
-
---
97
-
---@param chan Channel // this channel
98
-
---@return string name name of the channel
99
-
function channel.name(chan) end
100
105
101
106
return comlink
+6
docs/comlink_channel.3.scd
+6
docs/comlink_channel.3.scd
···
10
10
11
11
*local name = channel:name*()
12
12
13
+
*channel:mark_read*()
14
+
13
15
*channel:send_msg*(_msg_)
14
16
15
17
# DESCRIPTION
16
18
17
19
A *channel* represents an IRC channel.
20
+
21
+
*channel:mark_read*
22
+
Mark this channel as read. This will set the READMARKER to the time of
23
+
the last received message.
18
24
19
25
*channel:send_msg*
20
26
A method on *channel* which accepts a string (_msg_). _Msg_ is sent to