Committing changes to the comments, to improve code documentation.

[mirror_edk2.git] / MdeModulePkg / Include / Library / ResetSystemLib.h

diff --git a/MdeModulePkg/Include/Library/ResetSystemLib.h b/MdeModulePkg/Include/Library/ResetSystemLib.h
index fd92135d7a17f46ec99031cefc867f70933bfd0f..f77c441ad57bdd8670f833c1211739aaecb88726 100644 (file)
--- a/MdeModulePkg/Include/Library/ResetSystemLib.h
+++ b/MdeModulePkg/Include/Library/ResetSystemLib.h
@@ -1,6 +1,6 @@
 /** @file\r
   System reset Library Services.  This library class defines a set of\r
-  methods to reset whole system.\r
+  methods that reset the whole system.\r
 \r
   Copyright (c) 2005 - 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
@@ -17,13 +17,12 @@
 #define __RESET_SYSTEM_LIB_H__\r
 \r
 /**\r
-  Calling this function causes a system-wide reset. This sets\r
-  all circuitry within the system to its initial state. This type of reset \r
+  This function causes a system-wide reset (cold reset), in which\r
+  all circuitry within the system returns to its initial state. This type of reset \r
   is asynchronous to system operation and operates without regard to \r
   cycle boundaries.\r
 \r
-  System reset should not return, if it returns, it means the system does \r
-  not support cold reset.\r
+  If this function returns, it means that the system does not support cold reset. \r
 **/\r
 VOID\r
 EFIAPI\r
@@ -32,11 +31,10 @@ ResetCold (
   );\r
 \r
 /**\r
-  Calling this function causes a system-wide initialization. The processors \r
-  are set to their initial state, and pending cycles are not corrupted.\r
+  This function causes a system-wide initialization (warm reset), in which all processors \r
+  are set to their initial state. Pending cycles are not corrupted.\r
 \r
-  System reset should not return, if it returns, it means the system does \r
-  not support warm reset.\r
+  If this function returns, it means that the system does not support warm reset.\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -45,10 +43,10 @@ ResetWarm (
   );\r
 \r
 /**\r
-  Calling this function causes the system to enter a power state equivalent \r
+  This function causes the system to enter a power state equivalent \r
   to the ACPI G2/S5 or G3 states.\r
   \r
-  System shutdown should not return, if it returns, it means the system does \r
+  If this function returns, it means the system does \r
   not support shut down reset.\r
 **/\r
 VOID\r
@@ -58,11 +56,11 @@ ResetShutdown (
   );\r
 \r
 /**\r
-  Calling this function causes the system to enter S3 and then\r
+  This function causes the system to enter S3 and then\r
   wake up immediately.\r
   \r
-  Reset update should not return, if it returns, it means the\r
-  library does not the feature.\r
+  If this function returns, it means the\r
+  system does not support the feature.\r
 **/\r
 VOID\r
 EFIAPI\r