Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Protocol / GenericMemoryTest.h

diff --git a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
index 68905159d620510c6be52845d38940e45003e7e8..1abaf88fdaabdf85f36f77b3b07c0426483fdfa9 100644 (file)
--- a/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
+++ b/MdeModulePkg/Include/Protocol/GenericMemoryTest.h
@@ -22,7 +22,7 @@ typedef struct _EFI_GENERIC_MEMORY_TEST_PROTOCOL  EFI_GENERIC_MEMORY_TEST_PROTOC
 \r
 ///\r
 /// Memory test coverage level\r
-/// Ignore op not test memory, Quick and Sparse op test memory quickly, Extensive op test memory detailedly.\r
+/// Ignore chooses not to test memory, Quick and Sparse test some memory, and Extensive performs a detailed memory test.\r
 ///\r
 typedef enum {\r
   IGNORE,\r
@@ -41,9 +41,7 @@ typedef enum {
   @param  RequireSoftECCInit  Indicate if the memory need software ECC init. \r
 \r
   @retval EFI_SUCCESS         The generic memory test is initialized correctly. \r
-  @retval EFI_NO_MEDIA        There is not any non-tested memory found, which means  \r
-                              that the memory test driver have not detect any \r
-                              non-tested extended memory in current system. \r
+  @retval EFI_NO_MEDIA        The system had no memory to be tested. \r
 \r
 **/\r
 typedef\r
@@ -60,15 +58,14 @@ EFI_STATUS
 \r
   @param  This                Protocol instance pointer. \r
   @param  TestedMemorySize    Return the tested extended memory size. \r
-  @param  TotalMemorySize     Return the whole system physical memory size, this  \r
-                              value may be changed if some error DIMMs is disabled in some case. \r
-  @param  ErrorOut            TRUE if the memory error occurs.\r
-  @param  IfTestAbort         Indicate if the user press "ESC" to skip the memory test. \r
+  @param  TotalMemorySize     Return the whole system physical memory size. \r
+                                                                                                               The total memory size does not include memory in a slot with a disabled DIMM.  \r
+  @param  ErrorOut            TRUE if the memory error occured.\r
+  @param  IfTestAbort         Indicates that the user pressed "ESC" to skip the memory test. \r
 \r
-  @retval EFI_SUCCESS         One block of memory pass test.\r
-  @retval EFI_NOT_FOUND       Indicate all the non-tested memory blocks have been\r
-                              already gone through.\r
-  @retval EFI_DEVICE_ERROR    Memory device error occurs and no agent can handle it.\r
+  @retval EFI_SUCCESS         One block of memory passed the test.\r
+  @retval EFI_NOT_FOUND       All memory blocks have already been tested.\r
+  @retval EFI_DEVICE_ERROR    Memory device error occured, and no agent can handle it.\r
 \r
 **/\r
 typedef\r
@@ -87,9 +84,7 @@ EFI_STATUS
 \r
   @param  This                Protocol instance pointer. \r
 \r
-  @retval EFI_SUCCESS         Success. Then free all the generic memory test driver\r
-                              allocated resource and notify to platform memory\r
-                              test driver that memory test finished.\r
+  @retval EFI_SUCCESS         Success. All resources used in the memory test are freed.\r
 \r
 **/\r
 typedef\r
@@ -99,8 +94,8 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  Provide capability to test compatible range used by some sepcial\r
-  driver before BDS perform memory test.\r
+  Provides the capability to test the compatible range used by a special\r
+  driver.\r
 \r
   @param  This                Protocol instance pointer. \r
   @param  StartAddress        The start address of the compatible memory range that\r