update file header
authorywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:10:34 +0000 (02:10 +0000)
committerywu21 <ywu21@6f19259b-4bc3-4df7-8a09-765794883524>
Wed, 10 Dec 2008 02:10:34 +0000 (02:10 +0000)
update function header
delete useless #include "IScsiConfigNVDataStruc.h"

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6943 6f19259b-4bc3-4df7-8a09-765794883524

MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h

index eedad99..e4f2645 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
-  The header file of IScsiConfig.c\r
+  The header file of IScsiConfig.c.\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation.<BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -10,14 +10,6 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  IScsiConfig.h\r
-\r
-Abstract:\r
-\r
-  The header file of IScsiConfig.c\r
-\r
 **/\r
 \r
 #ifndef _ISCSI_CONFIG_H_\r
@@ -30,7 +22,6 @@ Abstract:
 #include <Library/DebugLib.h>\r
 #include <Library/BaseLib.h>\r
 #include <Library/NetLib.h>\r
-#include "IScsiConfigNVDataStruc.h"\r
 \r
 extern UINT8  IScsiConfigDxeBin[];\r
 extern UINT8  IScsiDxeStrings[];\r
@@ -90,16 +81,13 @@ typedef struct _ISCSI_FORM_CALLBACK_INFO {
   Updates the iSCSI configuration form to add/delete an entry for the iSCSI\r
   device specified by the Controller.\r
 \r
-  @param  DriverBindingHandle[in] The driverbinding handle.\r
-\r
-  @param  Controller[in]          The controller handle of the iSCSI device.\r
-\r
-  @param  AddForm[in]             Whether to add or delete a form entry.\r
+  @param[in]  DriverBindingHandle The driverbinding handle.\r
+  @param[in]  Controller          The controller handle of the iSCSI device.\r
+  @param[in]  AddForm             Whether to add or delete a form entry.\r
 \r
   @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
-\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
-\r
+  @retval Others                  Some unexpected errors happened.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
@@ -111,12 +99,11 @@ IScsiConfigUpdateForm (
 /**\r
   Initialize the iSCSI configuration form.\r
 \r
-  @param  DriverBindingHandle[in] The iSCSI driverbinding handle.\r
-\r
-  @retval EFI_SUCCESS             The iSCSI configuration form is initialized.\r
-\r
-  @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
+  @param[in]  DriverBindingHandle  The iSCSI driverbinding handle.\r
 \r
+  @retval EFI_SUCCESS              The iSCSI configuration form is initialized.\r
+  @retval EFI_OUT_OF_RESOURCES     Failed to allocate memory.\r
+  @retval Others                   Some unexpected error happened.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigFormInit (\r
@@ -128,12 +115,10 @@ IScsiConfigFormInit (
   device configuration entries, uninstall the form callback protocol and\r
   free the resources used.\r
 \r
-  @param  DriverBindingHandle[in] The iSCSI driverbinding handle.\r
-\r
+  @param[in]  DriverBindingHandle The iSCSI driverbinding handle.\r
+  \r
   @retval EFI_SUCCESS             The iSCSI configuration form is unloaded.\r
-\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
-\r
 **/\r
 EFI_STATUS\r
 IScsiConfigFormUnload (\r