[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

1 files changed, 22 insertions, 2 deletions

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
index 92b3039..75bc7a1 100644
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiDhcp.h
@@ -1,4 +1,5 @@
-/*++

+/** @file

+  Data structure for DHCP support

 

 Copyright (c) 2004 - 2008, Intel Corporation

 All rights reserved. This program and the accompanying materials

@@ -14,8 +15,9 @@ Module Name:
   IScsiDhcp.h

 

 Abstract:

+  The header file of IScsiDhcp.c

 

---*/

+**/

 

 #ifndef _ISCSI_DHCP_H_

 #define _ISCSI_DHCP_H_

@@ -45,6 +47,24 @@ typedef struct _ISCSI_ROOT_PATH_FIELD {
   UINT8 Len;

 } ISCSI_ROOT_PATH_FIELD;

 

+/**

+  Parse the DHCP ACK to get the address configuration and DNS information.

+  

+  @param  Image[in]             The handle of the driver image.

+

+  @param  Controller[in]        The handle of the controller;

+

+  @param  ConfigData[in]        The session configuration data.

+

+  @retval EFI_SUCCESS           The DNS information is got from the DHCP ACK.

+

+  @retval EFI_NO_MAPPING        DHCP failed to acquire address and other information.

+

+  @retval EFI_INVALID_PARAMETER The DHCP ACK's DNS option is mal-formatted.

+

+  @retval EFI_DEVICE_ERROR      Some unexpected error happened.

+

+**/

 EFI_STATUS

 IScsiDoDhcp (

   IN EFI_HANDLE                 Image,