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

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

diff --git a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
index f5960aa6e7df1585bb267aa3704f963c0c0f568d..8f9d92881a6263f257c99a6fbac195344a559a51 100644 (file)
--- a/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
+++ b/MdeModulePkg/Library/GenericBdsLib/BdsBoot.c
@@ -72,17 +72,17 @@ BdsLibDoLegacyBoot (
 \r
 \r
 /**\r
-  Process the boot option follow the EFI 1.1 specification and\r
+  Process the boot option follow the UEFI specification and\r
   special treat the legacy boot option with BBS_DEVICE_PATH.\r
 \r
   @param  Option                 The boot option need to be processed\r
   @param  DevicePath             The device path which describe where to load the\r
                                  boot image or the legcy BBS device path to boot\r
                                  the legacy OS\r
-  @param  ExitDataSize           Returned directly from gBS->StartImage ()\r
-  @param  ExitData               Returned directly from gBS->StartImage ()\r
+  @param  ExitDataSize           The size of exit data.\r
+  @param  ExitData               Data returned when Boot image failed.\r
 \r
-  @retval EFI_SUCCESS            Status from gBS->StartImage ()\r
+  @retval EFI_SUCCESS            Boot from the input boot option successfully.\r
   @retval EFI_NOT_FOUND          If the Device Path is not found in the system\r
 \r
 **/\r
@@ -510,8 +510,8 @@ BdsExpandPartitionPartialDevicePathToFull (
   @param  HardDriveDevicePath    A device path which starts with a hard drive media\r
                                  device path.\r
 \r
-  @retval TRUE                   There is a matched device path instance FALSE\r
-  @retval FALSE                  There is no matched device path instance\r
+  @retval TRUE                   There is a matched device path instance.\r
+  @retval FALSE                  There is no matched device path instance.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1114,13 +1114,13 @@ BdsLibEnumerateAllBootOption (
 }\r
 \r
 /**\r
-  Build the boot option with the handle parsed in.\r
+  Build the boot option with the handle parsed in\r
 \r
   @param  Handle                 The handle which present the device path to create\r
                                  boot option\r
   @param  BdsBootOptionList      The header of the link list which indexed all\r
                                  current boot options\r
-  @param  String                 Boot option name.\r
+  @param  String                 The description of the boot option.\r
 \r
 **/\r
 VOID\r
@@ -1178,7 +1178,7 @@ BdsLibBuildOptionFromShell (
 }\r
 \r
 /**\r
-  Boot from the EFI1.1 spec defined "BootNext" variable\r
+  Boot from the UEFI spec defined "BootNext" variable.\r
 \r
 **/\r
 VOID\r
@@ -1238,7 +1238,6 @@ BdsLibBootNext (
 \r
   @param  DevicePath             Device Path to a  bootable device\r
 \r
-  @retval NULL                   The device path points to an EFI bootable Media\r
   @retval NULL                   The media on the DevicePath is not bootable\r
 \r
 **/\r
@@ -1558,11 +1557,11 @@ BdsGetBootTypeFromDevicePath (
   Check whether the Device path in a boot option point to a valide bootable device,\r
   And if CheckMedia is true, check the device is ready to boot now.\r
 \r
-  @param DevPath        the Device path in a boot option\r
-  @param CheckMedia     if true, check the device is ready to boot now.\r
+  @param  DevPath     the Device path in a boot option\r
+  @param  CheckMedia  if true, check the device is ready to boot now.\r
 \r
-  @retval TRUE          the Device path  is valide\r
-  @retval FALSE         the Device path  is invalide .\r
+  @retval TRUE        the Device path  is valide\r
+  @retval FALSE       the Device path  is invalide .\r
 \r
 **/\r
 BOOLEAN\r
@@ -1729,7 +1728,7 @@ EFI_STATUS
 EFIAPI\r
 BdsLibUpdateFvFileDevicePath (\r
   IN  OUT EFI_DEVICE_PATH_PROTOCOL      ** DevicePath,\r
-  IN      EFI_GUID                      *FileGuid\r
+  IN  EFI_GUID                          *FileGuid\r
   )\r
 {\r
   EFI_DEVICE_PATH_PROTOCOL      *TempDevicePath;\r