X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=blobdiff_plain;f=IntelFrameworkPkg%2FInclude%2FProtocol%2FAcpiS3Save.h;h=6c804693560efef68bab67f4bf1af2cd9bb01fbf;hp=2fb269e60cf8342b8a8d79acba002ded5c866ad3;hb=2bbaeb0d624f1d7758edd0a8d61322af209a1b1a;hpb=534b8251cc3c62a2a7cf90afb379692c1af2a35f

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