]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Library/BaseLib.h
Correct minor comments
[mirror_edk2.git] / MdePkg / Include / Library / BaseLib.h
index fcddbf2c231328619281ff50955d58fe2d856d10..dadf367602d6c71dba3d589bc1e0fcd15d7b3f9a 100644 (file)
@@ -1815,9 +1815,9 @@ GetPowerOfTwo64 (
   from little endian to big endian or vice versa. The byte swapped value is\r
   returned.\r
 \r
-  @param  Value Operand A 16-bit unsigned value.\r
+  @param  Value A 16-bit unsigned value.\r
 \r
-  @return The byte swapped Operand.\r
+  @return The byte swapped value.\r
 \r
 **/\r
 UINT16\r
@@ -1834,9 +1834,9 @@ SwapBytes16 (
   from little endian to big endian or vice versa. The byte swapped value is\r
   returned.\r
 \r
-  @param  Value Operand A 32-bit unsigned value.\r
+  @param  Value A 32-bit unsigned value.\r
 \r
-  @return The byte swapped Operand.\r
+  @return The byte swapped value.\r
 \r
 **/\r
 UINT32\r
@@ -1853,9 +1853,9 @@ SwapBytes32 (
   from little endian to big endian or vice versa. The byte swapped value is\r
   returned.\r
 \r
-  @param  Value Operand A 64-bit unsigned value.\r
+  @param  Value A 64-bit unsigned value.\r
 \r
-  @return The byte swapped Operand.\r
+  @return The byte swapped value.\r
 \r
 **/\r
 UINT64\r
@@ -4968,21 +4968,21 @@ AsmPalCall (
 ///\r
 typedef union {\r
   struct {\r
-    UINT32  CF:1;           /// Carry Flag\r
-    UINT32  Reserved_0:1;   /// Reserved\r
-    UINT32  PF:1;           /// Parity Flag\r
-    UINT32  Reserved_1:1;   /// Reserved\r
-    UINT32  AF:1;           /// Auxiliary Carry Flag\r
-    UINT32  Reserved_2:1;   /// Reserved\r
-    UINT32  ZF:1;           /// Zero Flag\r
-    UINT32  SF:1;           /// Sign Flag\r
-    UINT32  TF:1;           /// Trap Flag\r
-    UINT32  IF:1;           /// Interrupt Enable Flag\r
-    UINT32  DF:1;           /// Direction Flag\r
-    UINT32  OF:1;           /// Overflow Flag\r
-    UINT32  IOPL:2;         /// I/O Privilege Level\r
-    UINT32  NT:1;           /// Nested Task\r
-    UINT32  Reserved_3:1;   /// Reserved\r
+    UINT32  CF:1;           ///< Carry Flag\r
+    UINT32  Reserved_0:1;   ///< Reserved\r
+    UINT32  PF:1;           ///< Parity Flag\r
+    UINT32  Reserved_1:1;   ///< Reserved\r
+    UINT32  AF:1;           ///< Auxiliary Carry Flag\r
+    UINT32  Reserved_2:1;   ///< Reserved\r
+    UINT32  ZF:1;           ///< Zero Flag\r
+    UINT32  SF:1;           ///< Sign Flag\r
+    UINT32  TF:1;           ///< Trap Flag\r
+    UINT32  IF:1;           ///< Interrupt Enable Flag\r
+    UINT32  DF:1;           ///< Direction Flag\r
+    UINT32  OF:1;           ///< Overflow Flag\r
+    UINT32  IOPL:2;         ///< I/O Privilege Level\r
+    UINT32  NT:1;           ///< Nested Task\r
+    UINT32  Reserved_3:1;   ///< Reserved\r
   } Bits;\r
   UINT16    Uint16;\r
 } IA32_FLAGS16;\r
@@ -4994,28 +4994,28 @@ typedef union {
 ///\r
 typedef union {\r
   struct {\r
-    UINT32  CF:1;           /// Carry Flag\r
-    UINT32  Reserved_0:1;   /// Reserved\r
-    UINT32  PF:1;           /// Parity Flag\r
-    UINT32  Reserved_1:1;   /// Reserved\r
-    UINT32  AF:1;           /// Auxiliary Carry Flag\r
-    UINT32  Reserved_2:1;   /// Reserved\r
-    UINT32  ZF:1;           /// Zero Flag\r
-    UINT32  SF:1;           /// Sign Flag\r
-    UINT32  TF:1;           /// Trap Flag\r
-    UINT32  IF:1;           /// Interrupt Enable Flag\r
-    UINT32  DF:1;           /// Direction Flag\r
-    UINT32  OF:1;           /// Overflow Flag\r
-    UINT32  IOPL:2;         /// I/O Privilege Level\r
-    UINT32  NT:1;           /// Nested Task\r
-    UINT32  Reserved_3:1;   /// Reserved\r
-    UINT32  RF:1;           /// Resume Flag\r
-    UINT32  VM:1;           /// Virtual 8086 Mode\r
-    UINT32  AC:1;           /// Alignment Check\r
-    UINT32  VIF:1;          /// Virtual Interrupt Flag\r
-    UINT32  VIP:1;          /// Virtual Interrupt Pending\r
-    UINT32  ID:1;           /// ID Flag\r
-    UINT32  Reserved_4:10;  /// Reserved\r
+    UINT32  CF:1;           ///< Carry Flag\r
+    UINT32  Reserved_0:1;   ///< Reserved\r
+    UINT32  PF:1;           ///< Parity Flag\r
+    UINT32  Reserved_1:1;   ///< Reserved\r
+    UINT32  AF:1;           ///< Auxiliary Carry Flag\r
+    UINT32  Reserved_2:1;   ///< Reserved\r
+    UINT32  ZF:1;           ///< Zero Flag\r
+    UINT32  SF:1;           ///< Sign Flag\r
+    UINT32  TF:1;           ///< Trap Flag\r
+    UINT32  IF:1;           ///< Interrupt Enable Flag\r
+    UINT32  DF:1;           ///< Direction Flag\r
+    UINT32  OF:1;           ///< Overflow Flag\r
+    UINT32  IOPL:2;         ///< I/O Privilege Level\r
+    UINT32  NT:1;           ///< Nested Task\r
+    UINT32  Reserved_3:1;   ///< Reserved\r
+    UINT32  RF:1;           ///< Resume Flag\r
+    UINT32  VM:1;           ///< Virtual 8086 Mode\r
+    UINT32  AC:1;           ///< Alignment Check\r
+    UINT32  VIF:1;          ///< Virtual Interrupt Flag\r
+    UINT32  VIP:1;          ///< Virtual Interrupt Pending\r
+    UINT32  ID:1;           ///< ID Flag\r
+    UINT32  Reserved_4:10;  ///< Reserved\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_EFLAGS32;\r
@@ -5027,20 +5027,20 @@ typedef union {
 ///\r
 typedef union {\r
   struct {\r
-    UINT32  PE:1;           /// Protection Enable\r
-    UINT32  MP:1;           /// Monitor Coprocessor\r
-    UINT32  EM:1;           /// Emulation\r
-    UINT32  TS:1;           /// Task Switched\r
-    UINT32  ET:1;           /// Extension Type\r
-    UINT32  NE:1;           /// Numeric Error\r
-    UINT32  Reserved_0:10;  /// Reserved\r
-    UINT32  WP:1;           /// Write Protect\r
-    UINT32  Reserved_1:1;   /// Reserved\r
-    UINT32  AM:1;           /// Alignment Mask\r
-    UINT32  Reserved_2:10;  /// Reserved\r
-    UINT32  NW:1;           /// Mot Write-through\r
-    UINT32  CD:1;           /// Cache Disable\r
-    UINT32  PG:1;           /// Paging\r
+    UINT32  PE:1;           ///< Protection Enable\r
+    UINT32  MP:1;           ///< Monitor Coprocessor\r
+    UINT32  EM:1;           ///< Emulation\r
+    UINT32  TS:1;           ///< Task Switched\r
+    UINT32  ET:1;           ///< Extension Type\r
+    UINT32  NE:1;           ///< Numeric Error\r
+    UINT32  Reserved_0:10;  ///< Reserved\r
+    UINT32  WP:1;           ///< Write Protect\r
+    UINT32  Reserved_1:1;   ///< Reserved\r
+    UINT32  AM:1;           ///< Alignment Mask\r
+    UINT32  Reserved_2:10;  ///< Reserved\r
+    UINT32  NW:1;           ///< Mot Write-through\r
+    UINT32  CD:1;           ///< Cache Disable\r
+    UINT32  PG:1;           ///< Paging\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_CR0;\r
@@ -5052,24 +5052,24 @@ typedef union {
 ///\r
 typedef union {\r
   struct {\r
-    UINT32  VME:1;          /// Virtual-8086 Mode Extensions\r
-    UINT32  PVI:1;          /// Protected-Mode Virtual Interrupts\r
-    UINT32  TSD:1;          /// Time Stamp Disable\r
-    UINT32  DE:1;           /// Debugging Extensions\r
-    UINT32  PSE:1;          /// Page Size Extensions\r
-    UINT32  PAE:1;          /// Physical Address Extension\r
-    UINT32  MCE:1;          /// Machine Check Enable\r
-    UINT32  PGE:1;          /// Page Global Enable\r
-    UINT32  PCE:1;          /// Performance Monitoring Counter\r
-                            /// Enable\r
-    UINT32  OSFXSR:1;       /// Operating System Support for\r
-                            /// FXSAVE and FXRSTOR instructions\r
-    UINT32  OSXMMEXCPT:1;   /// Operating System Support for\r
-                            /// Unmasked SIMD Floating Point\r
-                            /// Exceptions\r
-    UINT32  Reserved_0:2;   /// Reserved\r
-    UINT32  VMXE:1;         /// VMX Enable\r
-    UINT32  Reserved_1:18;  /// Reseved\r
+    UINT32  VME:1;          ///< Virtual-8086 Mode Extensions\r
+    UINT32  PVI:1;          ///< Protected-Mode Virtual Interrupts\r
+    UINT32  TSD:1;          ///< Time Stamp Disable\r
+    UINT32  DE:1;           ///< Debugging Extensions\r
+    UINT32  PSE:1;          ///< Page Size Extensions\r
+    UINT32  PAE:1;          ///< Physical Address Extension\r
+    UINT32  MCE:1;          ///< Machine Check Enable\r
+    UINT32  PGE:1;          ///< Page Global Enable\r
+    UINT32  PCE:1;          ///< Performance Monitoring Counter\r
+                            ///< Enable\r
+    UINT32  OSFXSR:1;       ///< Operating System Support for\r
+                            ///< FXSAVE and FXRSTOR instructions\r
+    UINT32  OSXMMEXCPT:1;   ///< Operating System Support for\r
+                            ///< Unmasked SIMD Floating Point\r
+                            ///< Exceptions\r
+    UINT32  Reserved_0:2;   ///< Reserved\r
+    UINT32  VMXE:1;         ///< VMX Enable\r
+    UINT32  Reserved_1:18;  ///< Reseved\r
   } Bits;\r
   UINTN     UintN;\r
 } IA32_CR4;\r