From 3915bf5787ced7f7681a8ea6c300a8153c2c701c Mon Sep 17 00:00:00 2001
From: "7u83@mail.ru" <7u83@mail.ru@noemail.net>
Date: Tue, 7 Apr 2015 12:54:26 +0000
Subject: [PATCH] Added comments.

FossilOrigin-Name: 63db9e0973255068703930ea26785ae0bcd6f4e103a66d5b0233e11ae117b008
---
 src/capwap/md5sum.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/src/capwap/md5sum.c b/src/capwap/md5sum.c
index ecc5db7f..c1b1ac68 100644
--- a/src/capwap/md5sum.c
+++ b/src/capwap/md5sum.c
@@ -6,10 +6,17 @@
 
 #include "capwap_crypto.h"
 
-
 #define BLOCK_SIZE 4096
 
-
+/**
+ * Calculate MD5 checksum for an opened file. 
+ * @param digest destination buffer for calculated 
+ *   checksum (16 bytes, for a predifned constant use #CW_MD5_DIGEST_SIZE)
+ * @param infile filehanle 
+ * 
+ * Remember to set the file pointer to the beginning of the file, before
+ * calling this function. Therefor use fseek(file,0,SEEK_SET).
+ */
 int cw_fgetmd5sum(uint8_t *digest, FILE *infile)
 {
 	struct md5_ctx ctx;