Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / S3Resume.h

diff --git a/IntelFrameworkPkg/Include/Ppi/S3Resume.h b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
index b04a62ab792c4ca0179fb3a778f9654e92d9b53f..2509eb53b62482f7e9dc36d05305ad16ab5bcb61 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/S3Resume.h
+++ b/IntelFrameworkPkg/Include/Ppi/S3Resume.h
@@ -11,13 +11,13 @@
   Before using this PPI, the caller has to ensure the necessary information for the S3 resume, such as\r
   the following, is available for the S3 resume boot path:\r
   - EFI_ACPI_S3_RESUME_SCRIPT_TABLE script table. Type\r
-    EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel® Platform Innovation\r
+    EFI_ACPI_S3_RESUME_SCRIPT_TABLE is defined in the Intel Platform Innovation\r
     Framework for EFI Boot Script Specification.\r
   - OS waking vector.\r
   - The reserved memory range to be used for the S3 resume.\r
   Otherwise, the S3 resume boot path may fail.\r
   \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, 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
@@ -29,8 +29,8 @@
   Module Name:  S3Resume.h\r
 \r
   @par Revision Reference:\r
-  This PPI is defined in Framework of EFI S3 Resume Boot Path spec.\r
-  Version 0.9\r
+  This PPI is defined in Framework for EFI S3 Resume Boot Path spec.\r
+  Version 0.9.\r
 \r
 **/\r
 \r
@@ -59,21 +59,19 @@ typedef struct _EFI_PEI_S3_RESUME_PPI   EFI_PEI_S3_RESUME_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG) (\r
+(EFIAPI *EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG)(\r
   IN EFI_PEI_SERVICES   **PeiServices\r
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   EFI_PEI_S3_RESUME_PPI accomplishes the firmware S3 resume boot\r
   path and transfers control to OS.\r
-\r
-  @param S3RestoreConfig\r
-  Restores the platform to its preboot configuration for an S3 resume and\r
-  jumps to the OS waking vector.\r
-\r
 **/\r
 struct _EFI_PEI_S3_RESUME_PPI {\r
+  ///\r
+  /// Restores the platform to its preboot configuration for an S3 resume and\r
+  /// jumps to the OS waking vector.\r
+  ///\r
   EFI_PEI_S3_RESUME_PPI_RESTORE_CONFIG  S3RestoreConfig;\r
 };\r
 \r