aboutsummaryrefslogtreecommitdiff
path: root/include/template.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/template.h')
-rw-r--r--include/template.h32
1 files changed, 16 insertions, 16 deletions
diff --git a/include/template.h b/include/template.h
index 55d7494..e3d83fb 100644
--- a/include/template.h
+++ b/include/template.h
@@ -43,23 +43,23 @@ int tpl_render_to_file(char *str, const char *filename);
typedef int tplfunc(void *frame, void *data_out);
struct tplfunc_frame {
- char *key;
- tplfunc *func;
- void *data_in;
- int argc;
+ char *key; ///< Name of the function
+ tplfunc *func; ///< Pointer to the function
+ void *data_in; ///< Pointer to internal data (can be NULL)
+ int argc; ///< Maximum number of arguments to accept
union {
- char **t_char_refptr;
- char *t_char_ptr;
- void *t_void_ptr;
- int *t_int_ptr;
- unsigned *t_uint_ptr;
- float *t_float_ptr;
- double *t_double_ptr;
- char t_char;
- int t_int;
- unsigned t_uint;
- float t_float;
- double t_double;
+ char **t_char_refptr; ///< &pointer
+ char *t_char_ptr; ///< pointer
+ void *t_void_ptr; ///< pointer to void
+ int *t_int_ptr; ///< pointer to int
+ unsigned *t_uint_ptr; ///< pointer to unsigned int
+ float *t_float_ptr; ///< pointer to float
+ double *t_double_ptr; ///< pointer to double
+ char t_char; ///< type of char
+ int t_int; ///< type of int
+ unsigned t_uint; ///< type of unsigned int
+ float t_float; ///< type of float
+ double t_double; ///< type of double
} argv[10]; // accept up to 10 arguments
};