Synchronize GenericBdsLib library class's header file to library instance.

[mirror_edk2.git] / MdeModulePkg / Library / GenericBdsLib / BdsConsole.c

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
index ff72aa0f08be04abb260cd01fe77cebe6f4fd3fa..d923804e3fdbef63030846b87f8c6298d3faba63 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsConsole.c
@@ -60,7 +60,7 @@ IsNvNeed (
                                    from the console variable ConVarName, this\r
                                    parameter can not be multi-instance.\r
 \r
-  @retval EFI_UNSUPPORTED          Add or remove the same device path.\r
+  @retval EFI_UNSUPPORTED          The added device path is same to the removed one.\r
   @retval EFI_SUCCESS              Success add or remove the device path from  the\r
                                    console variable.\r
 \r
@@ -184,7 +184,6 @@ BdsLibUpdateConsoleVariable (
   @param  ConVarName               Console related variable name, ConIn, ConOut,\r
                                    ErrOut.\r
 \r
-  @retval EFI_UNSUPPORTED          Request console variable does not exist.\r
   @retval EFI_NOT_FOUND            There is not any console devices connected\r
                                    success\r
   @retval EFI_SUCCESS              Success connect any one instance of the console\r
@@ -359,8 +358,7 @@ BdsLibConnectAllConsoles (
 \r
   @retval EFI_SUCCESS              At least one of the ConIn and ConOut device have\r
                                    been connected success.\r
-  @retval EFI_STATUS               Return the status of\r
-                                   BdsLibConnectConsoleVariable ().\r
+  @retval EFI_STATUS               Return the status of BdsLibConnectConsoleVariable ().\r
 \r
 **/\r
 EFI_STATUS\r
@@ -597,7 +595,7 @@ ConvertBmpToGopBlt (
   @param  Password        Password used to lock ConIn device.\r
 \r
   @retval EFI_SUCCESS     lock the Console In Spliter virtual handle successfully.\r
-  @retval EFI_UNSUPPORTED Password not found.\r
+  @retval EFI_UNSUPPORTED Password not found\r
 \r
 **/\r
 EFI_STATUS\r
@@ -621,21 +619,18 @@ LockKeyboards (
 \r
 /**\r
   Use Console Control to turn off UGA based Simple Text Out consoles from going\r
-  to the UGA device. Put up LogoFile on every UGA device that is a console.\r
+  to the UGA device. Put up LogoFile on every UGA device that is a console\r
 \r
-  @param  LogoFile        File name of logo to display on the center of the screen.\r
+  @param[in]  LogoFile   File name of logo to display on the center of the screen.\r
 \r
   @retval EFI_SUCCESS     ConsoleControl has been flipped to graphics and logo displayed.\r
-  @retval EFI_UNSUPPORTED Logo not found.\r
-                          Fail to locate ConsoleControl protocol.\r
-                          Fail to get UgaDraw or Gop handle.\r
-                          Fail to switch grahic mode.\r
+  @retval EFI_UNSUPPORTED Logo not found\r
 \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 EnableQuietBoot (\r
-  IN  EFI_GUID  *LogoFile   OPTIONAL\r
+  IN  EFI_GUID  *LogoFile\r
   )\r
 {\r
   EFI_STATUS                    Status;\r
@@ -877,8 +872,7 @@ EnableQuietBoot (
   Use Console Control to turn on UGA based Simple Text Out consoles. The UGA \r
   Simple Text Out screens will now be synced up with all non UGA output devices\r
 \r
-  @retval EFI_SUCCESS          UGA devices are back in text mode and synced up.\r
-  @retval EFI_UNSUPPORTED      Fail to locate ConsoleControl Protocol.\r
+  @retval EFI_SUCCESS     UGA devices are back in text mode and synced up.\r
 \r
 **/\r
 EFI_STATUS\r