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 0059e0193c4dab458b12d49c90652261a81febc2..f97b6b5460a0c45bb99cb99038f8333be3b3a972 100644 (file)
--- a/MdeModulePkg/Include/Library/S3Lib.h
+++ b/MdeModulePkg/Include/Library/S3Lib.h
@@ -1,14 +1,14 @@
 /** @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 - 2007, Intel Corporation\r
-  All rights reserved. This program and the accompanying materials\r
-  are licensed and made available under the terms and conditions of the BSD License\r
-  which accompanies this distribution.  The full text of the license may be found at\r
-  http://opensource.org/licenses/bsd-license.php\r
-  \r
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2005 - 2008, Intel Corporation. <BR>\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution.  The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
@@ -16,17 +16,17 @@
 #define __S3_LIB_H__\r
 \r
 /**\r
-  Calling this function causes the system restore config from S3.\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
-S3RestoreConfig (\r
+AcpiS3ResumeOs (\r
   VOID\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
 \r