remove unnecessary comments introduced by tools from MdePkg. The regular express...

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

diff --git a/MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange64.c b/MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange64.c
index 6bdbedad1f05f47a36975e0214259f0be527ccfc..faf61d13efaeb22fb4b25c9b4c50da893ca85036 100644 (file)
--- a/MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange64.c
+++ b/MdePkg/Library/BaseLib/Ia32/InterlockedCompareExchange64.c
@@ -12,11 +12,25 @@
 \r
 **/\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
 \r
 \r
+\r
+/**\r
+  Performs an atomic compare exchange operation on a 64-bit unsigned integer.\r
+\r
+  Performs an atomic compare exchange operation on the 64-bit unsigned integer specified\r
+  by Value.  If Value is equal to CompareValue, then Value is set to ExchangeValue and\r
+  CompareValue is returned.  If Value is not equal to CompareValue, then Value is returned.\r
+  The compare exchange operation must be performed using MP safe mechanisms.\r
+\r
+  @param  Value         A pointer to the 64-bit value for the compare exchange\r
+                        operation.\r
+  @param  CompareValue  64-bit value used in compare operation.\r
+  @param  ExchangeValue 64-bit value used in exchange operation.\r
+\r
+  @return The original *Value before exchange.\r
+\r
+**/\r
 UINT64\r
 EFIAPI\r
 InternalSyncCompareExchange64 (\r