From 2b77d6273ba47af3020a827d48d0ff3330d76ba5 Mon Sep 17 00:00:00 2001 From: John Darrington Date: Sat, 18 Jul 2009 12:38:02 +0200 Subject: [PATCH] Add comment explaining the meaning of encoding to data_out --- src/data/data-out.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/src/data/data-out.c b/src/data/data-out.c index 20a0b46d..94a6130a 100644 --- a/src/data/data-out.c +++ b/src/data/data-out.c @@ -113,19 +113,23 @@ data_out_legacy (const union value *input, const char *encoding, } } -/* Converts the INPUT value into a UTF8 encoded string, according to format - specification FORMAT. +/* Converts the INPUT value into a UTF8 encoded string, according + to format specification FORMAT. VALUE must be the correct width for FORMAT, that is, its width must be fmt_var_width(FORMAT). + ENCODING must be the encoding of INPUT. Normally this can + be obtained by calling dict_get_encoding on the dictionary + with which INPUT is associated. + The return value is dynamically allocated, and must be freed by the caller. If POOL is non-null, then the return value is allocated on that pool. */ char * -data_out_pool (const union value *input, const char *encoding, const struct fmt_spec *format, - struct pool *pool) +data_out_pool (const union value *input, const char *encoding, + const struct fmt_spec *format, struct pool *pool) { char *output = xmalloc (format->w + 1); char *t ; -- 2.30.2