From ad940f15c9754d415e2c10b174a3a8d7ed34db4d Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Wed, 26 Nov 2014 15:57:42 +0000 Subject: Fix base64 API doxygen comments --- include/nsutils/base64.h | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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 +/** + * 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, -- cgit v1.2.3