summaryrefslogtreecommitdiff
path: root/MdePkg/Include/Library/BaseLib.h
diff options
context:
space:
mode:
authorlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-09 08:22:53 +0000
committerlgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-09 08:22:53 +0000
commit2a53dabf6286ee56774bbd47aadf70aa78f0cd25 (patch)
tree4ab5c4af22a5a67146e43cad1ec8711d25bbec5f /MdePkg/Include/Library/BaseLib.h
parent214099c788f9b213c525802b189398da256b637d (diff)
Correct minor comments
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6932 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Library/BaseLib.h')
-rw-r--r--MdePkg/Include/Library/BaseLib.h150
1 files changed, 75 insertions, 75 deletions
diff --git a/MdePkg/Include/Library/BaseLib.h b/MdePkg/Include/Library/BaseLib.h
index fcddbf2c2..dadf36760 100644
--- a/MdePkg/Include/Library/BaseLib.h
+++ b/MdePkg/Include/Library/BaseLib.h
@@ -1815,9 +1815,9 @@ GetPowerOfTwo64 (
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 16-bit unsigned value.
+ @param Value A 16-bit unsigned value.
- @return The byte swapped Operand.
+ @return The byte swapped value.
**/
UINT16
@@ -1834,9 +1834,9 @@ SwapBytes16 (
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 32-bit unsigned value.
+ @param Value A 32-bit unsigned value.
- @return The byte swapped Operand.
+ @return The byte swapped value.
**/
UINT32
@@ -1853,9 +1853,9 @@ SwapBytes32 (
from little endian to big endian or vice versa. The byte swapped value is
returned.
- @param Value Operand A 64-bit unsigned value.
+ @param Value A 64-bit unsigned value.
- @return The byte swapped Operand.
+ @return The byte swapped value.
**/
UINT64
@@ -4968,21 +4968,21 @@ AsmPalCall (
///
typedef union {
struct {
- UINT32 CF:1; /// Carry Flag
- UINT32 Reserved_0:1; /// Reserved
- UINT32 PF:1; /// Parity Flag
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AF:1; /// Auxiliary Carry Flag
- UINT32 Reserved_2:1; /// Reserved
- UINT32 ZF:1; /// Zero Flag
- UINT32 SF:1; /// Sign Flag
- UINT32 TF:1; /// Trap Flag
- UINT32 IF:1; /// Interrupt Enable Flag
- UINT32 DF:1; /// Direction Flag
- UINT32 OF:1; /// Overflow Flag
- UINT32 IOPL:2; /// I/O Privilege Level
- UINT32 NT:1; /// Nested Task
- UINT32 Reserved_3:1; /// Reserved
+ UINT32 CF:1; ///< Carry Flag
+ UINT32 Reserved_0:1; ///< Reserved
+ UINT32 PF:1; ///< Parity Flag
+ UINT32 Reserved_1:1; ///< Reserved
+ UINT32 AF:1; ///< Auxiliary Carry Flag
+ UINT32 Reserved_2:1; ///< Reserved
+ UINT32 ZF:1; ///< Zero Flag
+ UINT32 SF:1; ///< Sign Flag
+ UINT32 TF:1; ///< Trap Flag
+ UINT32 IF:1; ///< Interrupt Enable Flag
+ UINT32 DF:1; ///< Direction Flag
+ UINT32 OF:1; ///< Overflow Flag
+ UINT32 IOPL:2; ///< I/O Privilege Level
+ UINT32 NT:1; ///< Nested Task
+ UINT32 Reserved_3:1; ///< Reserved
} Bits;
UINT16 Uint16;
} IA32_FLAGS16;
@@ -4994,28 +4994,28 @@ typedef union {
///
typedef union {
struct {
- UINT32 CF:1; /// Carry Flag
- UINT32 Reserved_0:1; /// Reserved
- UINT32 PF:1; /// Parity Flag
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AF:1; /// Auxiliary Carry Flag
- UINT32 Reserved_2:1; /// Reserved
- UINT32 ZF:1; /// Zero Flag
- UINT32 SF:1; /// Sign Flag
- UINT32 TF:1; /// Trap Flag
- UINT32 IF:1; /// Interrupt Enable Flag
- UINT32 DF:1; /// Direction Flag
- UINT32 OF:1; /// Overflow Flag
- UINT32 IOPL:2; /// I/O Privilege Level
- UINT32 NT:1; /// Nested Task
- UINT32 Reserved_3:1; /// Reserved
- UINT32 RF:1; /// Resume Flag
- UINT32 VM:1; /// Virtual 8086 Mode
- UINT32 AC:1; /// Alignment Check
- UINT32 VIF:1; /// Virtual Interrupt Flag
- UINT32 VIP:1; /// Virtual Interrupt Pending
- UINT32 ID:1; /// ID Flag
- UINT32 Reserved_4:10; /// Reserved
+ UINT32 CF:1; ///< Carry Flag
+ UINT32 Reserved_0:1; ///< Reserved
+ UINT32 PF:1; ///< Parity Flag
+ UINT32 Reserved_1:1; ///< Reserved
+ UINT32 AF:1; ///< Auxiliary Carry Flag
+ UINT32 Reserved_2:1; ///< Reserved
+ UINT32 ZF:1; ///< Zero Flag
+ UINT32 SF:1; ///< Sign Flag
+ UINT32 TF:1; ///< Trap Flag
+ UINT32 IF:1; ///< Interrupt Enable Flag
+ UINT32 DF:1; ///< Direction Flag
+ UINT32 OF:1; ///< Overflow Flag
+ UINT32 IOPL:2; ///< I/O Privilege Level
+ UINT32 NT:1; ///< Nested Task
+ UINT32 Reserved_3:1; ///< Reserved
+ UINT32 RF:1; ///< Resume Flag
+ UINT32 VM:1; ///< Virtual 8086 Mode
+ UINT32 AC:1; ///< Alignment Check
+ UINT32 VIF:1; ///< Virtual Interrupt Flag
+ UINT32 VIP:1; ///< Virtual Interrupt Pending
+ UINT32 ID:1; ///< ID Flag
+ UINT32 Reserved_4:10; ///< Reserved
} Bits;
UINTN UintN;
} IA32_EFLAGS32;
@@ -5027,20 +5027,20 @@ typedef union {
///
typedef union {
struct {
- UINT32 PE:1; /// Protection Enable
- UINT32 MP:1; /// Monitor Coprocessor
- UINT32 EM:1; /// Emulation
- UINT32 TS:1; /// Task Switched
- UINT32 ET:1; /// Extension Type
- UINT32 NE:1; /// Numeric Error
- UINT32 Reserved_0:10; /// Reserved
- UINT32 WP:1; /// Write Protect
- UINT32 Reserved_1:1; /// Reserved
- UINT32 AM:1; /// Alignment Mask
- UINT32 Reserved_2:10; /// Reserved
- UINT32 NW:1; /// Mot Write-through
- UINT32 CD:1; /// Cache Disable
- UINT32 PG:1; /// Paging
+ UINT32 PE:1; ///< Protection Enable
+ UINT32 MP:1; ///< Monitor Coprocessor
+ UINT32 EM:1; ///< Emulation
+ UINT32 TS:1; ///< Task Switched
+ UINT32 ET:1; ///< Extension Type
+ UINT32 NE:1; ///< Numeric Error
+ UINT32 Reserved_0:10; ///< Reserved
+ UINT32 WP:1; ///< Write Protect
+ UINT32 Reserved_1:1; ///< Reserved
+ UINT32 AM:1; ///< Alignment Mask
+ UINT32 Reserved_2:10; ///< Reserved
+ UINT32 NW:1; ///< Mot Write-through
+ UINT32 CD:1; ///< Cache Disable
+ UINT32 PG:1; ///< Paging
} Bits;
UINTN UintN;
} IA32_CR0;
@@ -5052,24 +5052,24 @@ typedef union {
///
typedef union {
struct {
- UINT32 VME:1; /// Virtual-8086 Mode Extensions
- UINT32 PVI:1; /// Protected-Mode Virtual Interrupts
- UINT32 TSD:1; /// Time Stamp Disable
- UINT32 DE:1; /// Debugging Extensions
- UINT32 PSE:1; /// Page Size Extensions
- UINT32 PAE:1; /// Physical Address Extension
- UINT32 MCE:1; /// Machine Check Enable
- UINT32 PGE:1; /// Page Global Enable
- UINT32 PCE:1; /// Performance Monitoring Counter
- /// Enable
- UINT32 OSFXSR:1; /// Operating System Support for
- /// FXSAVE and FXRSTOR instructions
- UINT32 OSXMMEXCPT:1; /// Operating System Support for
- /// Unmasked SIMD Floating Point
- /// Exceptions
- UINT32 Reserved_0:2; /// Reserved
- UINT32 VMXE:1; /// VMX Enable
- UINT32 Reserved_1:18; /// Reseved
+ UINT32 VME:1; ///< Virtual-8086 Mode Extensions
+ UINT32 PVI:1; ///< Protected-Mode Virtual Interrupts
+ UINT32 TSD:1; ///< Time Stamp Disable
+ UINT32 DE:1; ///< Debugging Extensions
+ UINT32 PSE:1; ///< Page Size Extensions
+ UINT32 PAE:1; ///< Physical Address Extension
+ UINT32 MCE:1; ///< Machine Check Enable
+ UINT32 PGE:1; ///< Page Global Enable
+ UINT32 PCE:1; ///< Performance Monitoring Counter
+ ///< Enable
+ UINT32 OSFXSR:1; ///< Operating System Support for
+ ///< FXSAVE and FXRSTOR instructions
+ UINT32 OSXMMEXCPT:1; ///< Operating System Support for
+ ///< Unmasked SIMD Floating Point
+ ///< Exceptions
+ UINT32 Reserved_0:2; ///< Reserved
+ UINT32 VMXE:1; ///< VMX Enable
+ UINT32 Reserved_1:18; ///< Reseved
} Bits;
UINTN UintN;
} IA32_CR4;