Skip to content

Commit b676610

Browse files
Add documentation for Base16_Encode and Base64_Encode's behavior of adding a NULL terminator byte.
Fixes #5602
1 parent 0a0c430 commit b676610

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

doc/dox_comments/header_files/coding.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ int Base64_Decode(const byte* in, word32 inLen, byte* out,
4646
traditional ‘\n’ line endings, instead of escaped %0A line endings. Upon
4747
successfully completing, this function also sets outLen to the number
4848
of bytes written to the output buffer.
49+
If there is enough room in out to store an extra byte, a NULL terminator
50+
will be added. This will NOT be included in outLen.
4951
5052
\return 0 Returned upon successfully decoding the Base64 encoded input
5153
\return BAD_FUNC_ARG Returned if the output buffer is too small to
@@ -203,6 +205,8 @@ int Base16_Decode(const byte* in, word32 inLen, byte* out, word32* outLen);
203205
\ingroup Base_Encoding
204206
205207
\brief Encode input to base16 output.
208+
If there is enough room in out to store an extra byte, a NULL terminator
209+
will be added and included in outLen.
206210
207211
\return 0 Success
208212
\return BAD_FUNC_ARG Returns if in, out, or outLen is null or if outLen is

0 commit comments

Comments
 (0)