From: Dandan Bi <dandan.bi@intel.com>
Date: Tue, 4 Aug 2015 09:11:42 +0000 (+0000)
Subject: MdeModulePkg:Refine the code comments in UiApp
X-Git-Tag: edk2-stable201903~9133
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=3194d76fd1821d2babf681bc13826fa42a5f29db

MdeModulePkg:Refine the code comments in UiApp

Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Eric Dong <eric.dong@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@18151 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/MdeModulePkg/Application/UiApp/BootMaint/BootMaint.c b/MdeModulePkg/Application/UiApp/BootMaint/BootMaint.c
index 4f46ed69c0..91af4890d4 100644
--- a/MdeModulePkg/Application/UiApp/BootMaint/BootMaint.c
+++ b/MdeModulePkg/Application/UiApp/BootMaint/BootMaint.c
@@ -1360,7 +1360,6 @@ InitBootMaintenance(
   Remove the installed BootMaint and FileExplorer HiiPackages.
 
 **/
-
 VOID
 FreeBMPackage(
   VOID
diff --git a/MdeModulePkg/Application/UiApp/DeviceMngr/DeviceManager.h b/MdeModulePkg/Application/UiApp/DeviceMngr/DeviceManager.h
index 7fb68a3c28..057fc47c0e 100644
--- a/MdeModulePkg/Application/UiApp/DeviceMngr/DeviceManager.h
+++ b/MdeModulePkg/Application/UiApp/DeviceMngr/DeviceManager.h
@@ -139,7 +139,7 @@ InitializeDeviceManager (
 VOID
 FreeDeviceManager(
   VOID
-);
+  );
 
 /**
   Dynamic create Hii information for Device Manager.
@@ -150,6 +150,6 @@ FreeDeviceManager(
 VOID
 CreateDeviceManagerForm(
   IN EFI_FORM_ID      NextShowFormId
-);
+  );
 
 #endif
diff --git a/MdeModulePkg/Application/UiApp/FrontPage.c b/MdeModulePkg/Application/UiApp/FrontPage.c
index 7d1cf2a633..d30935be7a 100644
--- a/MdeModulePkg/Application/UiApp/FrontPage.c
+++ b/MdeModulePkg/Application/UiApp/FrontPage.c
@@ -598,6 +598,10 @@ CallFrontPage (
   return Status;
 }
 
+/**
+  Remove the installed packages from the HiiDatabase.
+
+**/
 VOID
 FreeFrontPage(
   VOID
diff --git a/MdeModulePkg/Application/UiApp/String.c b/MdeModulePkg/Application/UiApp/String.c
index ad3ba57771..b93b8ac54f 100644
--- a/MdeModulePkg/Application/UiApp/String.c
+++ b/MdeModulePkg/Application/UiApp/String.c
@@ -40,6 +40,10 @@ InitializeStringSupport (
   ASSERT (gStringPackHandle != NULL);
 }
 
+/**
+  Remove the string package.
+
+**/
 VOID
 UninitializeStringSupport (
   VOID
diff --git a/MdeModulePkg/Application/UiApp/String.h b/MdeModulePkg/Application/UiApp/String.h
index 1a0636698a..1aac6e8b9f 100644
--- a/MdeModulePkg/Application/UiApp/String.h
+++ b/MdeModulePkg/Application/UiApp/String.h
@@ -56,6 +56,10 @@ InitializeStringSupport (
   VOID
   );
 
+/**
+  Remove the string package.
+
+**/
 VOID
 UninitializeStringSupport (
   VOID
diff --git a/MdeModulePkg/Application/UiApp/UiApp.inf b/MdeModulePkg/Application/UiApp/UiApp.inf
index 626f558097..26c6b1b94d 100644
--- a/MdeModulePkg/Application/UiApp/UiApp.inf
+++ b/MdeModulePkg/Application/UiApp/UiApp.inf
@@ -59,6 +59,7 @@
   String.h
   Language.c
   Language.h
+  FormsetGuid.h
 
 [Packages]
   MdePkg/MdePkg.dec
@@ -106,34 +107,40 @@
   gEfiIfrBootMaintenanceGuid                    ## CONSUMES ## GUID
   
 [Protocols]
-  gEfiSimpleFileSystemProtocolGuid              ## PROTOCOL CONSUMES
-  gEfiLoadFileProtocolGuid                      ## PROTOCOL CONSUMES
-  gEfiSmbiosProtocolGuid                        ## PROTOCOL CONSUMES
-  gEfiGenericMemTestProtocolGuid                ## PROTOCOL CONSUMES
-  gEfiUgaDrawProtocolGuid |PcdUgaConsumeSupport ## PROTOCOL SOMETIMES_CONSUMES
-  gEfiBlockIoProtocolGuid                       ## PROTOCOL CONSUMES
-  gEfiGraphicsOutputProtocolGuid                ## PROTOCOL SOMETIMES_CONSUMES
-  gEfiSimpleTextInputExProtocolGuid             ## PROTOCOL CONSUMES
-  gEfiHiiConfigAccessProtocolGuid               ## PROTOCOL CONSUMES
-  gEfiFormBrowser2ProtocolGuid                  ## PROTOCOL CONSUMES
-  gEfiSerialIoProtocolGuid                      ## PROTOCOL CONSUMES
-  gEfiDevicePathProtocolGuid                    ## PROTOCOL CONSUMES
-  gEfiPciIoProtocolGuid                         ## PROTOCOL CONSUMES
-  gEfiDevicePathToTextProtocolGuid              ## PROTOCOL CONSUMES
-  gEfiBootLogoProtocolGuid                      ## PROTOCOL CONSUMES
+  gEfiSimpleFileSystemProtocolGuid              ## CONSUMES
+  gEfiLoadFileProtocolGuid                      ## CONSUMES
+  gEfiSmbiosProtocolGuid                        ## CONSUMES
+  gEfiGenericMemTestProtocolGuid                ## CONSUMES
+  gEfiUgaDrawProtocolGuid |PcdUgaConsumeSupport ## SOMETIMES_CONSUMES
+  gEfiBlockIoProtocolGuid                       ## CONSUMES
+  gEfiGraphicsOutputProtocolGuid                ## SOMETIMES_CONSUMES
+  gEfiSimpleTextInputExProtocolGuid             ## CONSUMES
+  gEfiHiiConfigAccessProtocolGuid               ## CONSUMES
+  gEfiFormBrowser2ProtocolGuid                  ## CONSUMES
+  gEfiSerialIoProtocolGuid                      ## CONSUMES
+  gEfiDevicePathProtocolGuid                    ## CONSUMES
+  gEfiPciIoProtocolGuid                         ## CONSUMES
+  gEfiDevicePathToTextProtocolGuid              ## CONSUMES
+  gEfiBootLogoProtocolGuid                      ## CONSUMES
 
 [FeaturePcd]
 
 [Pcd]
-  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLangCodes
-  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLang
-  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow
-  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn
+  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLangCodes  ## CONSUMES
+  gEfiMdePkgTokenSpaceGuid.PcdUefiVariableDefaultPlatformLang       ## SOMETIMES_CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow                       ## PRODUCES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn                    ## PRODUCES
+  ## CONSUMES
+  ## PRODUCES
   gEfiMdePkgTokenSpaceGuid.PcdPlatformBootTimeOut
-  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution
-  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution
+  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoHorizontalResolution       ## PRODUCES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdVideoVerticalResolution         ## PRODUCES
+  ## CONSUMES
+  ## SOMETIMES_PRODUCES
   gEfiMdeModulePkgTokenSpaceGuid.PcdSetupConOutColumn
+  ## CONSUMES
+  ## SOMETIMES_PRODUCES
   gEfiMdeModulePkgTokenSpaceGuid.PcdSetupConOutRow
-  gEfiMdeModulePkgTokenSpaceGuid.PcdSetupVideoHorizontalResolution
-  gEfiMdeModulePkgTokenSpaceGuid.PcdSetupVideoVerticalResolution
-  gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVersionString
+  gEfiMdeModulePkgTokenSpaceGuid.PcdSetupVideoHorizontalResolution  ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdSetupVideoVerticalResolution    ## CONSUMES
+  gEfiMdeModulePkgTokenSpaceGuid.PcdFirmwareVersionString           ## CONSUMES
\ No newline at end of file
diff --git a/MdeModulePkg/Include/Guid/HiiBootMaintenanceFormset.h b/MdeModulePkg/Include/Guid/HiiBootMaintenanceFormset.h
index 96c39f977d..25dcff81fd 100644
--- a/MdeModulePkg/Include/Guid/HiiBootMaintenanceFormset.h
+++ b/MdeModulePkg/Include/Guid/HiiBootMaintenanceFormset.h
@@ -1,4 +1,3 @@
-//
 /** @file
   Guid definition for Boot Maintainence Formset.