Add headers for docs
authorMyhailo Danylenko <isbear@ukrpost.net>
Tue, 21 Aug 2012 15:29:27 +0300
changeset 128 8692a6fbe415
parent 127 9157566033e8
child 129 ea30cf6c5bea
Add headers for docs
lua.c
util.c
--- a/lua.c	Tue Aug 07 20:58:31 2012 +0300
+++ b/lua.c	Tue Aug 21 15:29:27 2012 +0300
@@ -45,10 +45,17 @@
 #include "config.h"
 #include "util.h"
 
+/// Lua for mcabber
+/// Module provides embedded lua environment with some accessors to
+/// mcabber functionality.
+
 //
 //  options
 //
 
+/// 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
 #define OPT_MLUA_RC       "lua_init_filename"
 #define OPT_MLUA_LM_DEBUG "lua_lm_debug"
 
--- a/util.c	Tue Aug 07 20:58:31 2012 +0300
+++ b/util.c	Tue Aug 21 15:29:27 2012 +0300
@@ -20,6 +20,9 @@
 
 #include "util.h"
 
+/// Utility Lua Routines
+/// To handle conversion of enums and flag fields to/from human-readable strings.
+
 enum_value_t string2enum (const char *string, const string2enum_t *set)
 {
 	while (set->string) {