diff options
| author | Vincent Sanders <vince@kyllikki.org> | 2014-11-26 15:57:42 +0000 |
|---|---|---|
| committer | Vincent Sanders <vince@kyllikki.org> | 2014-11-26 15:57:42 +0000 |
| commit | ad940f15c9754d415e2c10b174a3a8d7ed34db4d (patch) | |
| tree | b05e96e6aee92be3be59fd4cf322dd1d7d4a311d /include/nsutils | |
| parent | f9916482a7a13ab19c15a7b0ca46857cccff85a1 (diff) | |
| download | libnsutils-ad940f15c9754d415e2c10b174a3a8d7ed34db4d.tar.gz libnsutils-ad940f15c9754d415e2c10b174a3a8d7ed34db4d.tar.bz2 | |
Fix base64 API doxygen comments
Diffstat (limited to 'include/nsutils')
| -rw-r--r-- | include/nsutils/base64.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/include/nsutils/base64.h b/include/nsutils/base64.h index f4622e8..2bb10e4 100644 --- a/include/nsutils/base64.h +++ b/include/nsutils/base64.h @@ -17,11 +17,33 @@ #include <nsutils/errors.h> +/** + * Base 64 encode data. + * + * allocate a buffer and encode source data into it using the Base64 encoding. + * + * \param input The source data to encode. + * \param input_length The length of the source data. + * \param output The buffer to recive data into, the caller must free. + * \param output_length The length of data placed in \a output + * \return NSERROR_OK on success and \a output updated else error code. + */ nserror nsu_base64_encode_alloc(const uint8_t *input, size_t input_length, uint8_t **output, size_t *output_length); +/** + * Base 64 decode data. + * + * allocate a buffer and decode source data into it using the Base64 encoding. + * + * \param input The source data to decode. + * \param input_length The length of the source data. + * \param output The buffer to recive data into, the caller must free. + * \param output_length The length of data placed in \a output + * \return NSERROR_OK on success and \a output updated else error code. + */ nserror nsu_base64_decode_alloc(const uint8_t *input, size_t input_length, uint8_t **output, |