start documentation using LuaDoc

diff --git a/src/irc.lua b/src/irc.lua
index 370627027048dfa42a5403c5ffc0d46a8a2414e5..426445833db36b235f857c906885537c6451a09a 100644 (file)
--- a/src/irc.lua
+++ b/src/irc.lua
@@ -1,3 +1,6 @@
+---
+-- Implementation of the main LuaIRC module
+
 -- initialization {{{
 local base =      _G
 local constants = require 'irc.constants'
@@ -10,6 +13,9 @@ local string =    require 'string'
 local table =     require 'table'
 -- }}}
 
+---
+-- LuaIRC - IRC framework written in Lua
+-- @release 0.02
 module 'irc'
 
 -- constants {{{