document contains()

1 files changed, 17 insertions, 12 deletions

diff --git a/src/irc/channel.lua b/src/irc/channel.lua
index 83cbeff..f1fbf3c 100644
--- a/src/irc/channel.lua
+++ b/src/irc/channel.lua
@@ -387,6 +387,23 @@ end
 -- }}}
 
 -- accessors {{{
+-- contains {{{
+---
+-- Test if a user is in the channel.
+-- @param self Channel object
+-- @param nick Nick to search for
+-- @return True if the nick is in the channel, false otherwise
+function contains(self, nick)
+    for member in self:each_member() do
+        local member_nick = member:gsub('@+', '')
+        if member_nick == nick then
+            return true
+        end
+    end
+    return false
+end
+-- }}}
+
 -- add_user() {{{
 function add_user(self, user, mode)
     mode = mode or ''
@@ -417,18 +434,6 @@ function change_status(self, user, on, mode)
 end
 -- }}}
 
--- contains() {{{
-function contains(self, nick)
-    for member in self:each_member() do
-        local member_nick = member:gsub('@+', '')
-        if member_nick == nick then
-            return true
-        end
-    end
-    return false
-end
--- }}}
-
 -- change_nick {{{
 function change_nick(self, old_nick, new_nick)
     for member in self:each_member() do