Doc fix.
authorSimon Josefsson <simon@josefsson.org>
Tue, 18 Apr 2006 22:25:51 +0000 (22:25 +0000)
committerSimon Josefsson <simon@josefsson.org>
Tue, 18 Apr 2006 22:25:51 +0000 (22:25 +0000)
lib/base64.c

index 9ef5f03..a27b73a 100644 (file)
@@ -305,7 +305,9 @@ isbase64 (char ch)
    otherwise.  If *OUTLEN is too small, as many bytes as possible will
    be written to OUT.  On return, *OUTLEN holds the length of decoded
    bytes in OUT.  Note that as soon as any non-alphabet characters are
-   encountered, decoding is stopped and false is returned. */
+   encountered, decoding is stopped and false is returned.  This means
+   that, when applicable, you must de-fold any CRLF that is part of
+   the data stream before calling this function.  */
 bool
 base64_decode (const char *restrict in, size_t inlen,
               char *restrict out, size_t *outlen)