Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
index 2fb269e60cf8342b8a8d79acba002ded5c866ad3..6c804693560efef68bab67f4bf1af2cd9bb01fbf 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
+++ b/IntelFrameworkPkg/Include/Protocol/AcpiS3Save.h
@@ -74,7 +74,7 @@ EFI_STATUS
   - Get the minimum memory length below 1 MB that is required for the S3 resume boot path.\r
   If LegacyMemoryAddress is NULL, the firmware will be unable to jump into a real-mode\r
   waking vector. However, it might still be able to jump into a flat-mode waking vector as long as the\r
-  OS provides a flat-mode waking vector. It is the caller\92s responsibility to ensure the\r
+  OS provides a flat-mode waking vector. It is the caller's responsibility to ensure the\r
   LegacyMemoryAddress is valid. If the LegacyMemoryAddress is higher than 1 MB,\r
   EFI_INVALID_PARAMETER will be returned.\r
 \r
@@ -95,9 +95,8 @@ EFI_STATUS
 );\r
 \r
 /**\r
-  @par Protocol Description:\r
   The EFI_ACPI_S3_SAVE_PROTOCOL is responsible for preparing all the information that the\r
-  Framework needs to restore the platform\92s preboot state during an S3 resume boot. This\r
+  Framework needs to restore the platform's preboot state during an S3 resume boot. This\r
   information can include the following:\r
     - The Framework boot script table, containing all necessary operations to initialize the platform\r
     - ACPI table information, such as RSDT, through which the OS waking vector can be located\r
@@ -114,16 +113,16 @@ EFI_STATUS
   that the target platform supports an S3 resume and then call EFI_ACPI_S3_SAVE_PROTOCOL\r
   to save the S3 resume information. The entire Framework boot script table will then be generated,\r
   assuming the platform currently is in the preboot state.\r
-\r
-  @param GetLegacyMemorySize\r
-  Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
-\r
-  @param S3Save\r
-  Prepare all information for an S3 resume.\r
-  \r
 **/\r
 struct _EFI_ACPI_S3_SAVE_PROTOCOL {\r
+  ///\r
+  /// Gets the size of legacy memory below 1 MB that is required for S3 resume.\r
+  ///\r
   EFI_ACPI_GET_LEGACY_MEMORY_SIZE   GetLegacyMemorySize;\r
+  \r
+  ///\r
+  /// Prepare all information for an S3 resume.\r
+  ///\r
   EFI_ACPI_S3_SAVE                  S3Save;\r
 };\r
 \r