Update api docs
authorMyhailo Danylenko <isbear@ukrpost.net>
Tue, 21 Aug 2012 15:44:05 +0300
changeset 130 de560dec87a5
parent 129 ea30cf6c5bea
child 131 d1d2754bbdaf
Update api docs
docs/api.mdwn
--- a/docs/api.mdwn	Tue Aug 21 15:32:19 2012 +0300
+++ b/docs/api.mdwn	Tue Aug 21 15:44:05 2012 +0300
@@ -6,8 +6,19 @@
 
 - - -
 
+<a name="Lua.for.mcabber"></a>
+## Lua for mcabber
+Module provides embedded lua environment with some accessors to
+mcabber functionality.
+
+<a name="Options"></a>
+### Options
+
+* lua_init_filename - lua script, that will be loaded at startup
+* lua_lm_debug      - if lm log handler is enabled, this option controls, whether lm log messages are dropped or passed to mcabber logging facility
+
 <a name="print"></a>
-## print
+### print
 Prints its arguments to log with default priority.  
 **Arguments:** something, ...  
 
@@ -304,8 +315,12 @@
 
 - - -
 
+<a name="Utility.Lua.Routines"></a>
+## Utility Lua Routines
+To handle conversion of enums and flag fields to/from human-readable strings.
+
 <a name="argument.enum.field"></a>
-## argument enum field
+### argument enum field
 String that will be converted to number or just plain number, that will be passed as is.
 Note, that if enum name is not recognized no error will be raised and default vale will be used.