Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Library / S3Lib.h

diff --git a/MdeModulePkg/Include/Library/S3Lib.h b/MdeModulePkg/Include/Library/S3Lib.h
index dd21d6e09c21e64a75503c932e22cdb06b8d0163..f97b6b5460a0c45bb99cb99038f8333be3b3a972 100644 (file)
--- a/MdeModulePkg/Include/Library/S3Lib.h
+++ b/MdeModulePkg/Include/Library/S3Lib.h
@@ -1,5 +1,5 @@
 /** @file\r
-  S3 Library. This library class defines a set of methods related do S3 mode.\r
+  S3 library class defines a set of methods related to S3 boot mode.\r
 \r
 Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
@@ -18,16 +18,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /**\r
   This function is responsible for calling the S3 resume vector in the ACPI Tables.\r
   \r
-  @retval EFI_SUCESS   Sucess to restore config from S3.\r
-  @retval Others       Fail to restore config from S3.\r
+  @retval EFI_SUCESS   Successfully restored config from S3.\r
+  @retval Others       Failed to restore config from S3.\r
 \r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 AcpiS3ResumeOs (\r
   VOID\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
 \r