Add some documentation on the arguments to the base64 encode/decode functions.
authorRussell Bryant <russell@russellbryant.com>
Tue, 6 Mar 2007 23:58:38 +0000 (23:58 +0000)
committerRussell Bryant <russell@russellbryant.com>
Tue, 6 Mar 2007 23:58:38 +0000 (23:58 +0000)
(inspired by issue #9215)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@58149 65c4cc65-6c06-0410-ace0-fbb531ad65f3

include/asterisk/utils.h

index 8981824..5c68a27 100644 (file)
@@ -161,7 +161,26 @@ void ast_md5_hash(char *output, char *input);
 void ast_sha1_hash(char *output, char *input);
 
 int ast_base64encode_full(char *dst, const unsigned char *src, int srclen, int max, int linebreaks);
+
+/*!
+ * \brief Encode data in base64
+ * \param dst the destination buffer
+ * \param src the source data to be encoded
+ * \param srclen the number of bytes present in the source buffer
+ * \param max the maximum number of bytes to write into the destination
+ *        buffer, *including* the terminating NULL character.
+ */
 int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max);
+
+/*!
+ * \brief Decode data from base64
+ * \param dst the destination buffer
+ * \param src the source buffer
+ * \param max The maximum number of bytes to write into the destination
+ *            buffer.  Note that this function will not ensure that the
+ *            destination buffer is NULL terminated.  So, in general,
+ *            this parameter should be sizeof(dst) - 1.
+ */
 int ast_base64decode(unsigned char *dst, const char *src, int max);
 
 /*!  \brief Turn text string to URI-encoded %XX version