[FFmpeg-cvslog] lavu/base64: extend/clarify doxy for the base64 API

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Tue Jan  1 18:19:07 2013 +0100| [69d75dc4dd10a0bd70b6d0d0b27733b373da1277] | committer: Stefano Sabatini

lavu/base64: extend/clarify doxy for the base64 API

Also improve overall consistency.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=69d75dc4dd10a0bd70b6d0d0b27733b373da1277
---

 libavutil/base64.h |   12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/libavutil/base64.h b/libavutil/base64.h
index b095576..514498e 100644
--- a/libavutil/base64.h
+++ b/libavutil/base64.h
@@ -46,15 +46,17 @@ int av_base64_decode(uint8_t *out, const char *in, int out_size);
  * Encode data to base64 and null-terminate.
  *
  * @param out      buffer for encoded data
- * @param out_size size in bytes of the output buffer, must be at
- *                 least AV_BASE64_SIZE(in_size)
- * @param in_size  size in bytes of the 'in' buffer
- * @return         'out' or NULL in case of error
+ * @param out_size size in bytes of the out buffer (including the
+ *                 null terminator), must be at least AV_BASE64_SIZE(in_size)
+ * @param in       input buffer containing the data to encode
+ * @param in_size  size in bytes of the in buffer
+ * @return         out or NULL in case of error
  */
 char *av_base64_encode(char *out, int out_size, const uint8_t *in, int in_size);
 
 /**
- * Calculate the output size needed to base64-encode x bytes.
+ * Calculate the output size needed to base64-encode x bytes to a
+ * null-terminated string.
  */
 #define AV_BASE64_SIZE(x)  (((x)+2) / 3 * 4 + 1)