Doc fix.
[pspp] / lib / base64.c
index 9ef5f03f3080d974fba4a4a57799db6670666a71..4dbd80a1c0c1797dc0faae125d9fa0b6e5111302 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 remove any line terminators 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)