MdePkg: Clean up source files

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

diff --git a/MdePkg/Library/BaseLib/Ia32/WriteCr4.c b/MdePkg/Library/BaseLib/Ia32/WriteCr4.c
index 04e7b0049162338e8de6fa9bef00131690c9dd55..868bed48b115a2447d890287e9595c2cd63c9df1 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/WriteCr4.c
+++ b/MdePkg/Library/BaseLib/Ia32/WriteCr4.c
@@ -1,22 +1,28 @@
 /** @file\r
   AsmWriteCr4 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
+  http://opensource.org/licenses/bsd-license.php.\r
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
+/**\r
+  Writes a value to Control Register 4 (CR4).\r
 \r
+  Writes and returns a new value to CR4. This function is only available on\r
+  IA-32 and x64. This writes a 32-bit value on IA-32 and a 64-bit value on x64.\r
 \r
+  @param  Value The value to write to CR4.\r
+\r
+  @return The value written to CR4.\r
+\r
+**/\r
 UINTN\r
 EFIAPI\r
 AsmWriteCr4 (\r