diff options
| author | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-17 08:28:51 +0000 |
|---|---|---|
| committer | eric_tian <eric_tian@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-04-17 08:28:51 +0000 |
| commit | 12618416ec7a468bc7e47d9739cf973a0bb418fc (patch) | |
| tree | 1a23c7d46665240f08b061aaa13832da602162d3 /MdeModulePkg/Universal/Network/IScsiDxe/Md5.h | |
| parent | d16fc3dbb3461dab1cb8a8df21b9e3c2e09723e6 (diff) | |
| download | edk2-12618416ec7a468bc7e47d9739cf973a0bb418fc.zip edk2-12618416ec7a468bc7e47d9739cf973a0bb418fc.tar.gz edk2-12618416ec7a468bc7e47d9739cf973a0bb418fc.tar.bz2 | |
[Description]
change the old code style to comply with Doxgen format
[Impaction]
add comments for every function
[Reference Info]
add comments to achieve the highest standard of code quality matrix
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5079 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/Network/IScsiDxe/Md5.h')
| -rw-r--r-- | MdeModulePkg/Universal/Network/IScsiDxe/Md5.h | 72 |
1 files changed, 29 insertions, 43 deletions
diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h index 365b5cb..dd59626 100644 --- a/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h +++ b/MdeModulePkg/Universal/Network/IScsiDxe/Md5.h @@ -1,4 +1,5 @@ -/*++
+/** @file
+ Header file for Md5
Copyright (c) 2004 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials
@@ -17,7 +18,7 @@ Abstract: Header file for Md5
---*/
+**/
#ifndef _MD5_H_
#define _MD5_H_
@@ -36,73 +37,58 @@ typedef struct _MD5_CTX { UINTN Count;
} MD5_CTX;
+/**
+ Initialize four 32-bits chaining variables and use them to do the Md5 transform.
+
+ @param Md5Ctx[in] the data structure of Md5
+
+ @retval EFI_SUCCESS initialization is ok
+
+**/
EFI_STATUS
MD5Init (
IN MD5_CTX *Md5Ctx
)
-/*++
-
-Routine Description:
-
- GC_TODO: Add function description
+;
-Arguments:
+/**
+ the external interface of Md5 algorithm
- Md5Ctx - GC_TODO: add argument description
+ @param Md5Ctx[in] the data structure of storing the original data
+ segment and the final result.
-Returns:
+ @param Data[in] the data wanted to be transformed.
- EFI_SUCCESS - GC_TODO: Add description for return value
+ @param DataLen[in] the length of data.
---*/
-;
+ @retval EFI_SUCCESS the transform is ok.
+**/
EFI_STATUS
MD5Update (
IN MD5_CTX *Md5Ctx,
IN VOID *Data,
IN UINTN DataLen
)
-/*++
-
-Routine Description:
-
- GC_TODO: Add function description
-
-Arguments:
+;
- Md5Ctx - GC_TODO: add argument description
- Data - GC_TODO: add argument description
- DataLen - GC_TODO: add argument description
+/**
+ accumulate the MD5 value of every data segment and generate the finial
+ result according to MD5 algorithm
-Returns:
+ @param Md5Ctx[in] the data structure of storing the original data
+ segment and the final result.
- EFI_SUCCESS - GC_TODO: Add description for return value
+ @param HashVal[out] the final 128-bits output.
---*/
-;
+ @retval EFI_SUCCESS the transform is ok.
+**/
EFI_STATUS
MD5Final (
IN MD5_CTX *Md5Ctx,
OUT UINT8 *HashVal
)
-/*++
-
-Routine Description:
-
- GC_TODO: Add function description
-
-Arguments:
-
- Md5Ctx - GC_TODO: add argument description
- HashVal - GC_TODO: add argument description
-
-Returns:
-
- EFI_SUCCESS - GC_TODO: Add description for return value
-
---*/
;
#endif // _MD5_H
|