diff options
author | Ludovic Courtès <ludo@gnu.org> | 2010-01-06 23:52:40 +0100 |
---|---|---|
committer | Ludovic Courtès <ludo@gnu.org> | 2010-01-07 11:10:35 +0100 |
commit | 29bcdbb05948a5f12d2d8cb36a0c3c582e738be3 (patch) | |
tree | ce67c5432b8c3333ffc179fdb1cb478ce35eff84 /libguile/strings.c | |
parent | 9fdee5b40b190585f3fac949a366dfcf06ad202a (diff) | |
download | guile-29bcdbb05948a5f12d2d8cb36a0c3c582e738be3.tar.gz |
Add in-source documentation of `scm_to_stringn ()'.
* libguile/strings.c (scm_to_stringn): Add documentation comment.
Diffstat (limited to 'libguile/strings.c')
-rw-r--r-- | libguile/strings.c | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/libguile/strings.c b/libguile/strings.c index d3bb3252f..d977655a2 100644 --- a/libguile/strings.c +++ b/libguile/strings.c @@ -1,4 +1,4 @@ -/* Copyright (C) 1995,1996,1998,2000,2001, 2004, 2006, 2008, 2009 Free Software Foundation, Inc. +/* Copyright (C) 1995,1996,1998,2000,2001, 2004, 2006, 2008, 2009, 2010 Free Software Foundation, Inc. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public License @@ -1605,7 +1605,10 @@ scm_to_locale_stringn (SCM str, size_t *lenp) scm_i_get_conversion_strategy (SCM_BOOL_F)); } -/* Low-level scheme to C string conversion function. */ +/* Return a malloc(3)-allocated buffer containing the contents of STR encoded + according to ENCODING. If LENP is non-NULL, set it to the size in bytes of + the returned buffer. If the conversion to ENCODING fails, apply the strategy + defined by HANDLER. */ char * scm_to_stringn (SCM str, size_t *lenp, const char *encoding, scm_t_string_failed_conversion_handler handler) |