Add header to utils
authorMyhailo Danylenko <isbear@ukrpost.net>
Sun, 19 Aug 2012 19:53:29 +0300
changeset 50 2278dd806ad3
parent 49 4b9d1a7e6861
child 51 dd1a2998d220
Add header to utils
docs/api.mdwn
util.c
--- a/docs/api.mdwn	Sun Aug 19 15:43:14 2012 +0300
+++ b/docs/api.mdwn	Sun Aug 19 19:53:29 2012 +0300
@@ -537,8 +537,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.
 
--- a/util.c	Sun Aug 19 15:43:14 2012 +0300
+++ b/util.c	Sun Aug 19 19:53:29 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) {