update file header

[mirror_edk2.git] / MdeModulePkg / Universal / Network / IScsiDxe / Md5.h

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
index 365b5cbbe6ff43e53eb482397433dc95ae46d742..fca782ce3435b5965f80208f13627427146e09bf 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h
@@ -1,4 +1,5 @@
-/*++\r
+/** @file\r
+  Header file for Md5\r
 \r
 Copyright (c) 2004 - 2008, Intel Corporation\r
 All rights reserved. This program and the accompanying materials\r
@@ -17,7 +18,7 @@ Abstract:
 \r
   Header file for Md5\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _MD5_H_\r
 #define _MD5_H_\r
@@ -36,73 +37,55 @@ typedef struct _MD5_CTX {
   UINTN       Count;\r
 } MD5_CTX;\r
 \r
+/**\r
+  Initialize four 32-bits chaining variables and use them to do the Md5 transform.\r
+\r
+  @param  Md5Ctx[in]  the data structure of Md5\r
+\r
+  @retval EFI_SUCCESS initialization is ok\r
+\r
+**/\r
 EFI_STATUS\r
 MD5Init (\r
   IN MD5_CTX  *Md5Ctx\r
-  )\r
-/*++\r
+  );\r
 \r
-Routine Description:\r
+/**\r
+  the external interface of Md5 algorithm\r
 \r
-  GC_TODO: Add function description\r
+  @param  Md5Ctx[in]  the data structure of storing the original data\r
+                      segment and the final result.\r
 \r
-Arguments:\r
+  @param  Data[in]    the data wanted to be transformed.\r
 \r
-  Md5Ctx  - GC_TODO: add argument description\r
+  @param  DataLen[in] the length of data.\r
 \r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
-;\r
+  @retval EFI_SUCCESS the transform is ok.\r
 \r
+**/\r
 EFI_STATUS\r
 MD5Update (\r
   IN MD5_CTX  *Md5Ctx,\r
   IN VOID     *Data,\r
   IN UINTN    DataLen\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
+  );\r
 \r
-Arguments:\r
+/**\r
+  accumulate the MD5 value of every data segment and generate the finial\r
+  result according to MD5 algorithm\r
 \r
-  Md5Ctx  - GC_TODO: add argument description\r
-  Data    - GC_TODO: add argument description\r
-  DataLen - GC_TODO: add argument description\r
+  @param  Md5Ctx[in]   the data structure of storing the original data\r
+                       segment and the final result.\r
 \r
-Returns:\r
+  @param  HashVal[out] the final 128-bits output.\r
 \r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
-;\r
+  @retval EFI_SUCCESS  the transform is ok.\r
 \r
+**/\r
 EFI_STATUS\r
 MD5Final (\r
   IN  MD5_CTX  *Md5Ctx,\r
   OUT UINT8    *HashVal\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  Md5Ctx  - GC_TODO: add argument description\r
-  HashVal - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS - GC_TODO: Add description for return value\r
-\r
---*/\r
-;\r
+  );\r
 \r
 #endif // _MD5_H\r