diff options
author | Wilmer van der Gaast <wilmer@gaast.net> | 2010-07-28 00:04:19 +0200 |
---|---|---|
committer | Wilmer van der Gaast <wilmer@gaast.net> | 2010-07-28 00:04:19 +0200 |
commit | f6f5eee77be1a91563da38337bb80b04cb2ae071 (patch) | |
tree | b77471103840b98a6d351bd09d275cb64b84d8a2 /set.h | |
parent | 82ca98619fc6fbef41de7235b5cc930961ef0cc0 (diff) |
Source documentation update, including a short HACKING file.
Diffstat (limited to 'set.h')
-rw-r--r-- | set.h | 11 |
1 files changed, 4 insertions, 7 deletions
@@ -36,10 +36,7 @@ struct set; remembers a default value for every setting. And to prevent the user from setting invalid values, you can write an evaluator function for every setting, which can check a new value and block it by returning - NULL, or replace it by returning a new value. See struct set.eval. - One thing that is really missing here is additional data for the - evaluator. This could be useful to add minimum and maximum values for - integers, for example. */ + NULL, or replace it by returning a new value. See struct set.eval. */ typedef char *(*set_eval) ( struct set *set, char *value ); @@ -65,9 +62,9 @@ typedef struct set int flags; /* See account.h, for example. set.c doesn't use this (yet?). */ - /* Eval: Returns SET_INVALID if the value is incorrect or exactly - the passed value variable. When returning a corrected value, - set_setstr() should be able to free() the returned string! */ + /* Eval: Returns SET_INVALID if the value is incorrect, exactly + the passed value variable, or a corrected value. In case of + the latter, set_setstr() will free() the returned string! */ set_eval eval; void *eval_data; struct set *next; |