1)update function header coding style issue

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

diff --git a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
index e4f2645d310f4b8a38811fbe88b4dfc04a5fccaf..eb6e0e38535992398a741e331a606e80dcaf2714 100644 (file)
--- a/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
+++ b/MdeModulePkg/Universal/Network/IScsiDxe/IScsiConfig.h
@@ -32,6 +32,31 @@ extern UINT8  IScsiDxeStrings[];
 \r
 #define ISCSI_FORM_CALLBACK_INFO_SIGNATURE  EFI_SIGNATURE_32 ('I', 'f', 'c', 'i')\r
 \r
+\r
+\r
+/**\r
+  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is clear, \r
+  then this macro return a pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r
+\r
+  If the DEBUG_PROPERTY_DEBUG_ASSERT_ENABLED bit of PcdDebugProperyMask is set,  \r
+  The Signature field of the data structure ISCSI_FORM_CALLBACK_INFO \r
+  is compared to TestSignature.  If the signatures match, then a pointer \r
+  to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO is returned.  \r
+  If the signatures do not match, then DebugAssert() is called with a description \r
+  of "CR has a bad signature" and Callback is returned.  \r
+\r
+  If the data type ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain the field\r
+  specified by Callback, then the module will not compile.\r
+\r
+  If ISCSI_FORM_CALLBACK_INFO_SIGNATURE does not contain a field called Signature, \r
+  then the module will not compile.\r
+\r
+  @param  Callback       Pointer to the specified field within the data \r
+                         structure ISCSI_FORM_CALLBACK_INFO.\r
+  @return                a pointer to the pointer to a data structure ISCSI_FORM_CALLBACK_INFO.\r
+  @return  Others        Some unexpected error happened.\r
+**/\r
+\r
 #define ISCSI_FORM_CALLBACK_INFO_FROM_FORM_CALLBACK(Callback) \\r
   CR ( \\r
   Callback, \\r
@@ -87,7 +112,7 @@ typedef struct _ISCSI_FORM_CALLBACK_INFO {
 \r
   @retval EFI_SUCCESS             The iSCSI configuration form is updated.\r
   @retval EFI_OUT_OF_RESOURCES    Failed to allocate memory.\r
-  @retval Others                  Some unexpected errors happened.\r
+  @retval Others                  Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigUpdateForm (\r
@@ -103,11 +128,11 @@ IScsiConfigUpdateForm (
 \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
+  @retval Others                   Other errors as indicated.\r
 **/\r
 EFI_STATUS\r
 IScsiConfigFormInit (\r
-  IN EFI_HANDLE  DriverBindingHandle\r
+  VOID\r
   );\r
 \r
 /**\r