Update the copyright notice format

[mirror_edk2.git] / MdePkg / Library / BaseLib / Ia32 / Monitor.c

diff --git a/MdePkg/Library/BaseLib/Ia32/Monitor.c b/MdePkg/Library/BaseLib/Ia32/Monitor.c
index a1b3f7b2df3c8e02ea7eabbb82e2f3bd634e31f6..13449d2f54d46ef906a970ccb454e8c73e021f26 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/Monitor.c
+++ b/MdePkg/Library/BaseLib/Ia32/Monitor.c
@@ -1,8 +1,8 @@
 /** @file\r
   AsmMonitor function\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
-  All rights reserved. This program and the accompanying materials\r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
   http://opensource.org/licenses/bsd-license.php\r
@@ -12,11 +12,22 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
+/**\r
+  Sets up a monitor buffer that is used by AsmMwait().\r
 \r
+  Executes a MONITOR instruction with the register state specified by Eax, Ecx\r
+  and Edx. Returns Eax. This function is only available on IA-32 and x64.\r
+\r
+  @param  RegisterEax The value to load into EAX or RAX before executing the MONITOR\r
+                      instruction.\r
+  @param  RegisterEcx The value to load into ECX or RCX before executing the MONITOR\r
+                      instruction.\r
+  @param  RegisterEdx The value to load into EDX or RDX before executing the MONITOR\r
+                      instruction.\r
+\r
+  @return RegisterEax\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmMonitor (\r