Code scrub:

[mirror_edk2.git] / MdePkg / Library / CpuLib / Ia32 / CpuPause.c

diff --git a/MdePkg/Library/CpuLib/Ia32/CpuPause.c b/MdePkg/Library/CpuLib/Ia32/CpuPause.c
index ee7c96736b344dc32ee9ef602f8b0645a9c1626a..c62503ae1041c1c1b910b682917d26df79502927 100644 (file)
--- a/MdePkg/Library/CpuLib/Ia32/CpuPause.c
+++ b/MdePkg/Library/CpuLib/Ia32/CpuPause.c
@@ -12,11 +12,17 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
 \r
+/**\r
+  Places the CPU in a pause state until an interrupt is\r
+  received.\r
 \r
+  Places the CPU in a pause state until an interrupt is\r
+  received. If interrupts are disabled prior to calling this\r
+  function, then the CPU will be placed in a pause state\r
+  indefinitely.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 CpuPause (\r