aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJeff Morriss <jeff.morriss@ulticom.com>2010-08-21 03:54:55 +0000
committerJeff Morriss <jeff.morriss@ulticom.com>2010-08-21 03:54:55 +0000
commit2a0128c25838db9fd2c90d91a8fb3b84b4831404 (patch)
tree64d473ae41dfd63108ee4ea903017857250dadf4 /doc
parentd2b84da490db34922c7138b20da2e3806fc7e10b (diff)
Document what prefs_register_string_preference() does with your value pointer.
svn path=/trunk/; revision=33873
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/README.developer b/doc/README.developer
index 21099d0bb4..061260d570 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -208,7 +208,7 @@ argument. You must do
call_routine2(xxx, format, ap);
va_end(ap);
-rather
+rather
va_start(ap, format);
call_routine1(xxx, format, ap);
call_routine2(xxx, format, ap);
@@ -3554,7 +3554,12 @@ Where: module - Returned by the prefs_register_protocol routine
description - Comments added to the preference file above the
preference value
var - pointer to the storage location that is updated when the
- field is changed in the preference dialog box
+ field is changed in the preference dialog box. Note that
+ with string preferences the given pointer is overwritten
+ with a pointer to a new copy of the string during the
+ preference registration. The passed-in string may be
+ freed, but you must keep another pointer to the string
+ in order to free it.
base - Base that the unsigned integer is expected to be in,
see strtoul(3).
enumvals - an array of enum_val_t structures. This must be