Code scrub:

[mirror_edk2.git] / MdePkg / Include / Library / BaseLib.h

diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index 6961c0a229a70f8cf70a27d52082d2bd9b7c608e..95e1b6d3144119f35a16c9f7a1b6dba44c9e7cfe 100644 (file)
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -471,7 +471,7 @@ StrStr (
 \r
   @param  String                           Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval UINTN\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINTN\r
@@ -511,7 +511,7 @@ StrDecimalToUintn (
 \r
   @param  String                           Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval UINT64\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINT64\r
@@ -553,7 +553,7 @@ StrDecimalToUint64 (
 \r
   @param  String                           Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval UINTN\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINTN\r
@@ -595,7 +595,7 @@ StrHexToUintn (
 \r
   @param  String                           Pointer to a Null-terminated Unicode string.\r
 \r
-  @retval UINT64\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINT64\r
@@ -1127,7 +1127,7 @@ AsciiStrStr (
 \r
   @param  String                           Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval UINTN\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINTN\r
@@ -1164,7 +1164,7 @@ AsciiStrDecimalToUintn (
 \r
   @param  String                           Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval UINT64\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINT64\r
@@ -1205,7 +1205,7 @@ AsciiStrDecimalToUint64 (
 \r
   @param  String                           Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval UINTN\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINTN\r
@@ -1246,7 +1246,7 @@ AsciiStrHexToUintn (
 \r
   @param  String                           Pointer to a Null-terminated ASCII string.\r
 \r
-  @retval UINT64\r
+  @retval Value translated from String.\r
 \r
 **/\r
 UINT64\r
@@ -1595,6 +1595,8 @@ IsNodeAtEnd (
 \r
   @param  FirstEntry  A pointer to a node in a linked list.\r
   @param  SecondEntry A pointer to another node in the same linked list.\r
+  \r
+  @return SecondEntry\r
 \r
 **/\r
 LIST_ENTRY *\r
@@ -2237,7 +2239,7 @@ WriteUnaligned16 (
 \r
   @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
 \r
-  @return The value read.\r
+  @return The value read from Buffer.\r
 \r
 **/\r
 UINT32\r
@@ -2259,7 +2261,7 @@ ReadUnaligned24 (
   @param  Buffer  Pointer to a 24-bit value that may be unaligned.\r
   @param  Value   24-bit value to write to Buffer.\r
 \r
-  @return The value written.\r
+  @return The value written to Buffer.\r
 \r
 **/\r
 UINT32\r
@@ -2280,7 +2282,7 @@ WriteUnaligned24 (
 \r
   @param  Uint32  Pointer to a 32-bit value that may be unaligned.\r
 \r
-  @return *Uint32\r
+  @return Value read from Uint32\r
 \r
 **/\r
 UINT32\r
@@ -2302,7 +2304,7 @@ ReadUnaligned32 (
   @param  Uint32  Pointer to a 32-bit value that may be unaligned.\r
   @param  Value   32-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return Value written to Uint32.\r
 \r
 **/\r
 UINT32\r
@@ -2323,7 +2325,7 @@ WriteUnaligned32 (
 \r
   @param  Uint64  Pointer to a 64-bit value that may be unaligned.\r
 \r
-  @return *Uint64\r
+  @return Value read from Uint64.\r
 \r
 **/\r
 UINT64\r
@@ -2345,7 +2347,7 @@ ReadUnaligned64 (
   @param  Uint64  Pointer to a 64-bit value that may be unaligned.\r
   @param  Value   64-bit value to write to Buffer.\r
 \r
-  @return Value\r
+  @return Value written to Uint64.\r
 \r
 **/\r
 UINT64\r
@@ -3048,7 +3050,7 @@ GetSpinLockProperties (
   @param  SpinLock  A pointer to the spin lock to initialize to the released\r
                     state.\r
 \r
-  @return SpinLock\r
+  @return SpinLock in release state.\r
 \r
 **/\r
 SPIN_LOCK *\r
@@ -3075,7 +3077,7 @@ InitializeSpinLock (
 \r
   @param  SpinLock  A pointer to the spin lock to place in the acquired state.\r
 \r
-  @return SpinLock\r
+  @return SpinLock accquired lock.\r
 \r
 **/\r
 SPIN_LOCK *\r
@@ -3120,7 +3122,7 @@ AcquireSpinLockOrFail (
 \r
   @param  SpinLock  A pointer to the spin lock to release.\r
 \r
-  @return SpinLock\r
+  @return SpinLock released lock.\r
 \r
 **/\r
 SPIN_LOCK *\r
@@ -3245,6 +3247,7 @@ InterlockedCompareExchange64 (
   @param  CompareValue  Pointer value used in compare operation.\r
   @param  ExchangeValue Pointer value used in exchange operation.\r
 \r
+  @return The original *Value before exchange.\r
 **/\r
 VOID *\r
 EFIAPI\r
@@ -3552,8 +3555,6 @@ LongJump (
 /**\r
   Enables CPU interrupts.\r
 \r
-  Enables CPU interrupts.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -3565,8 +3566,6 @@ EnableInterrupts (
 /**\r
   Disables CPU interrupts.\r
 \r
-  Disables CPU interrupts.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -3579,9 +3578,6 @@ DisableInterrupts (
   Disables CPU interrupts and returns the interrupt state prior to the disable\r
   operation.\r
 \r
-  Disables CPU interrupts and returns the interrupt state prior to the disable\r
-  operation.\r
-\r
   @retval TRUE  CPU interrupts were enabled on entry to this call.\r
   @retval FALSE CPU interrupts were disabled on entry to this call.\r
 \r
@@ -3597,9 +3593,6 @@ SaveAndDisableInterrupts (
   Enables CPU interrupts for the smallest window required to capture any\r
   pending interrupts.\r
 \r
-  Enables CPU interrupts for the smallest window required to capture any\r
-  pending interrupts.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -3611,8 +3604,8 @@ EnableDisableInterrupts (
 /**\r
   Retrieves the current CPU interrupt state.\r
 \r
-  Retrieves the current CPU interrupt state. Returns TRUE is interrupts are\r
-  currently enabled. Otherwise returns FALSE.\r
+  Returns TRUE is interrupts are currently enabled. Otherwise\r
+  returns FALSE.\r
 \r
   @retval TRUE  CPU interrupts are enabled.\r
   @retval FALSE CPU interrupts are disabled.\r