Add comments to crc32c module

diff --git a/lwext4/ext4_crc32c.c b/lwext4/ext4_crc32c.c
index 12642c9566e217bc0553c6499585b9a7b93b4d47..4d8c587642a715d260de692e236268fdf39ca9de 100644 (file)
--- a/lwext4/ext4_crc32c.c
+++ b/lwext4/ext4_crc32c.c
@@ -33,7 +33,7 @@
  */
 /**
  * @file  ext4_crc32c.c
- * @brief Crc32c routine. tahen from FreeBSD kernel.
+ * @brief Crc32c routine. Taken from FreeBSD kernel.
  */
 
 #include <ext4_config.h>

diff --git a/lwext4/ext4_crc32c.h b/lwext4/ext4_crc32c.h
index ee42de456f31888d8d8b3cb6d4ce836f86709af8..b2524e8c5c9301070468c08e61d444f89640e2d1 100644 (file)
--- a/lwext4/ext4_crc32c.h
+++ b/lwext4/ext4_crc32c.h
@@ -33,7 +33,7 @@
  */
 /**
  * @file  ext4_crc32c.h
- * @brief Crc32c routine. tahen from FreeBSD kernel.
+ * @brief Crc32c routine. Taken from FreeBSD kernel.
  */
 
 #ifndef LWEXT4_EXT4_CRC32C_H_
@@ -42,6 +42,11 @@
 #include <ext4_config.h>
 #include <stdint.h>
 
+/**@brief      CRC32C algorithm.
+ * @param      crc input feed
+ * @param      buffer input buffer
+ * @param      length input buffer length (bytes)
+ * @return     updated crc32c value*/
 uint32_t ext4_crc32c(uint32_t crc, const void *buffer, uint32_t length);