Add more comments for IntelFramework's header files.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / AcpiS3Save.h

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
index a9845e99dc05d8c328b38210efebd6a972d5a1f9..0ef70175b67755e126dae0ec91cdbe2aa22539ad 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
@@ -1,5 +1,8 @@
-/*++\r
-\r
+/** @file\r
+  This protocol is used to prepare all information that is needed for the S3 resume boot path. This\r
+  protocol is not required for all platforms.\r
+  This protocol is defined in framework S3Resume v0.9, page 21.\r
+  \r
 Copyright (c) 2006, 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
@@ -9,14 +12,7 @@ http://opensource.org/licenses/bsd-license.php
 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
-Module Name:\r
-\r
-  AcpiS3Save.h\r
-\r
-Abstract:\r
-\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _ACPI_S3_SAVE_PROTOCOL_H\r
 #define _ACPI_S3_SAVE_PROTOCOL_H\r