Browse code

core: kemi - commented relevant defines and structure members

Daniel-Constantin Mierla authored on 12/04/2016 13:15:04
Showing 1 changed files
... ...
@@ -25,19 +25,19 @@
25 25
 #include "str.h"
26 26
 #include "parser/msg_parser.h"
27 27
 
28
-#define SR_KEMIP_NONE	(0)
29
-#define SR_KEMIP_INT	(1<<0)
30
-#define SR_KEMIP_STR	(1<<1)
31
-#define SR_KEMIP_BOOL	(1<<2)
28
+#define SR_KEMIP_NONE	(0)		/* no type */
29
+#define SR_KEMIP_INT	(1<<0)	/* type integer */
30
+#define SR_KEMIP_STR	(1<<1)	/* type str* */
31
+#define SR_KEMIP_BOOL	(1<<2)	/* type boolean (0/1) */
32 32
 
33 33
 #define SR_KEMI_PARAMS_MAX	6
34 34
 
35 35
 typedef struct sr_kemi {
36
-	str mname;
37
-	str fname;
38
-	int rtype;
39
-	void *func;
40
-	int ptypes[SR_KEMI_PARAMS_MAX];
36
+	str mname; /* sub-module name */
37
+	str fname; /* function name */
38
+	int rtype; /* return type (supported SR_KEMIP_INT/BOOL) */
39
+	void *func; /* pointer to the C function to be executed */
40
+	int ptypes[SR_KEMI_PARAMS_MAX]; /* array with the type of parameters */
41 41
 } sr_kemi_t;
42 42
 
43 43
 typedef struct sr_kemi_item {