# HG changeset patch # User Myhailo Danylenko # Date 1345553045 -10800 # Node ID de560dec87a513ca1434d371e9d7712a16e8dd8e # Parent ea30cf6c5bea2c40f7f31eadfc89539141acf165 Update api docs diff -r ea30cf6c5bea -r de560dec87a5 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 @@ - - - + +## Lua for mcabber +Module provides embedded lua environment with some accessors to +mcabber functionality. + + +### 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 + -## print +### print Prints its arguments to log with default priority. **Arguments:** something, ... @@ -304,8 +315,12 @@ - - - + +## Utility Lua Routines +To handle conversion of enums and flag fields to/from human-readable strings. + -## 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.