summary refs log tree commit diff stats
path: root/lib/pure/irc.nim
diff options
context:
space:
mode:
authorDominik Picheta <dominikpicheta@googlemail.com>2012-11-04 22:30:19 +0000
committerDominik Picheta <dominikpicheta@googlemail.com>2012-11-04 22:30:19 +0000
commit76c4b0516a3e3db0ca32903f216230b2fcd48c07 (patch)
treeca5ebf6fb9de2a0628bb6f3e0755407278abe5f3 /lib/pure/irc.nim
parent42c8fd1fe2e8a045741c18cd02f9410cb7a990f8 (diff)
downloadNim-76c4b0516a3e3db0ca32903f216230b2fcd48c07.tar.gz
Many doc improvements. Changed Threads.joinThreads' param's type to varargs.
Diffstat (limited to 'lib/pure/irc.nim')
-rw-r--r--lib/pure/irc.nim16
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/pure/irc.nim b/lib/pure/irc.nim
index 60a86f2f1..24777f952 100644
--- a/lib/pure/irc.nim
+++ b/lib/pure/irc.nim
@@ -66,16 +66,16 @@ type
   
   TIRCEventType* = enum
     EvMsg, EvDisconnected
-  TIRCEvent* = object
+  TIRCEvent* = object ## IRC Event
     case typ*: TIRCEventType
-    of EvDisconnected: nil
-    of EvMsg:
-      cmd*: TIRCMType
+    of EvDisconnected: nil ## Disconnected from the server
+    of EvMsg:              ## Message from the server
+      cmd*: TIRCMType      ## Command (e.g. PRIVMSG)
       nick*, user*, host*, servername*: string
-      numeric*: string
-      params*: seq[string]
-      origin*: string ## The channel/user that this msg originated from
-      raw*: string
+      numeric*: string     ## Only applies to ``MNumeric``
+      params*: seq[string] ## Parameters of the IRC message
+      origin*: string      ## The channel/user that this msg originated from
+      raw*: string         ## Raw IRC message
   
 proc send*(irc: var TIRC, message: string, sendImmediately = false) =
   ## Sends ``message`` as a raw command. It adds ``\c\L`` for you.