Refine function comments for BdsDxe module.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / Capsules.c

diff --git a/MdeModulePkg/Universal/BdsDxe/Capsules.c b/MdeModulePkg/Universal/BdsDxe/Capsules.c
index 0ecf3a6f037ec1409d791143062e78361d1654bb..904a775493a7b61ad8e4fe21498ec858885ade0e 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Capsules.c
+++ b/MdeModulePkg/Universal/BdsDxe/Capsules.c
@@ -70,17 +70,16 @@ BdsLockFv (
   Then call the dispatcher to dispatch drivers from them. Finally, check\r
   the status of the updates.\r
 \r
+  This function should be called by BDS in case we need to do some\r
+  sort of processing even if there is no capsule to process. We\r
+  need to do this if an earlier update went away and we need to\r
+  clear the capsule variable so on the next reset PEI does not see it and\r
+  think there is a capsule available.\r
 \r
-  @param BootMode        - the current boot mode\r
+  @param BootMode                 the current boot mode\r
 \r
-  @retval  EFI_INVALID_PARAMETER  boot mode is not correct for an update\r
-                                  Note:\r
-                                  This function should be called by BDS in case we need to do some\r
-                                  sort of processing even if there is no capsule to process. We\r
-                                  need to do this if an earlier update went awry and we need to\r
-                                  clear the capsule variable so on the next reset PEI does not see it and\r
-                                  think there is a capsule available.\r
-  @retval EFI_SUCCESS There is no error when processing capsule\r
+  @retval EFI_INVALID_PARAMETER   boot mode is not correct for an update\r
+  @retval EFI_SUCCESS             There is no error when processing capsule\r
 \r
 **/\r
 EFI_STATUS\r