Refine code for MdePkg/Include/Ppi according to code review comments.

[mirror_edk2.git] / MdePkg / Include / Ppi / TemporaryRamSupport.h

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index 76e7c923eef91e2af75c7002ee585d9bcd64cd37..648127fc22e66ba7776a49e2396a85a9db4b2fc7 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -29,22 +29,15 @@
   permanent memory.\r
 \r
   @param PeiServices            Pointer to the PEI Services Table.\r
-\r
   @param TemporaryMemoryBase    Source Address in temporary memory from which the SEC or PEIM will copy the\r
                                 Temporary RAM contents.\r
-\r
   @param PermanentMemoryBase    Destination Address in permanent memory into which the SEC or PEIM will copy the\r
                                 Temporary RAM contents.\r
-\r
   @param CopySize               Amount of memory to migrate from temporary to permanent memory.\r
 \r
-\r
-\r
   @retval EFI_SUCCESS           The data was successfully returned.\r
-\r
-  @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize >\r
-                                TemporaryMemoryBase when TemporaryMemoryBase >\r
-                                PermanentMemoryBase.\r
+  @retval EFI_INVALID_PARAMETER PermanentMemoryBase + CopySize > TemporaryMemoryBase when\r
+                                TemporaryMemoryBase > PermanentMemoryBase.\r
 \r
 **/\r
 typedef\r
@@ -56,16 +49,14 @@ EFI_STATUS
   IN UINTN                    CopySize\r
 );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This service abstracts the ability to migrate contents of the platform early memory store.\r
-\r
-  @param ResetSystem\r
-  Perform the migration of contents of Temporary RAM to Permanent RAM.\r
-  Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.\r
-\r
-**/\r
+///\r
+/// This service abstracts the ability to migrate contents of the platform early memory store.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// Perform the migration of contents of Temporary RAM to Permanent RAM.\r
+  /// Terminate the Temporary RAM if it cannot coexist with the Permanent RAM.\r
+  ///\r
   TEMPORARY_RAM_MIGRATION   TemporaryRamMigration;\r
 } TEMPORARY_RAM_SUPPORT_PPI;\r
 \r