Refine doxygen comments

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8726 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index ae77f1f6e586113574ba2c7b1900a49f2e7ad7c2..d779e916ac8739ea2bde197c112a7b25328ed381 100644 (file)
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -39,8 +39,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /// Data structure of capsule guid hob entry\r
 ///\r
 typedef struct {\r
-  EFI_PHYSICAL_ADDRESS BaseAddress;  ///> Capsule data start address\r
-  UINT32 Length;                     ///> Length of capsule data.\r
+  EFI_PHYSICAL_ADDRESS BaseAddress;  ///< Capsule data start address\r
+  UINT32 Length;                     ///< Length of capsule data.\r
 } CAPSULE_HOB_INFO;\r
 \r
 extern EFI_GUID gEfiCapsuleVendorGuid;\r

diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index 6143dc70dd54ce9a70573599cb1cb430704e34b5..c37880a2295160a832a61bee564eeed1ca657c36 100644 (file)
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -29,8 +29,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 extern EFI_GUID gEfiMemoryTypeInformationGuid;\r
 \r
 typedef struct {\r
-  UINT32  Type;             ///> EFI memory type defined in UEFI specification.\r
-  UINT32  NumberOfPages;    ///> The pages of this type memory.\r
+  UINT32  Type;             ///< EFI memory type defined in UEFI specification.\r
+  UINT32  NumberOfPages;    ///< The pages of this type memory.\r
 } EFI_MEMORY_TYPE_INFORMATION;\r
 \r
 #endif\r

diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index b59fe8104059e25f4384042c6fb4cf75064282a2..de813da4b7a17a0efffc12f682159050ad53ee1e 100644 (file)
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -26,17 +26,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 typedef struct {\r
   EFI_PHYSICAL_ADDRESS  Handle;\r
-  CHAR8                 Token[PEI_PERFORMANCE_STRING_SIZE];   ///> Measured token string name \r
-  CHAR8                 Module[PEI_PERFORMANCE_STRING_SIZE];  ///> Module string name\r
-  UINT64                StartTimeStamp;                       ///> Start time point\r
-  UINT64                EndTimeStamp;                         ///> End time point\r
+  CHAR8                 Token[PEI_PERFORMANCE_STRING_SIZE];   ///< Measured token string name \r
+  CHAR8                 Module[PEI_PERFORMANCE_STRING_SIZE];  ///< Module string name\r
+  UINT64                StartTimeStamp;                       ///< Start time point\r
+  UINT64                EndTimeStamp;                         ///< End time point\r
 } PEI_PERFORMANCE_LOG_ENTRY;\r
 \r
 //\r
 // The header must be aligned at 8 bytes.\r
 // \r
 typedef struct {\r
-  UINT32                NumberOfEntries;  ///> The number of all performance log entries\r
+  UINT32                NumberOfEntries;  ///< The number of all performance log entries\r
   UINT32                Reserved;\r
 } PEI_PERFORMANCE_LOG_HEADER;\r
 \r
@@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
 \r
 typedef struct {\r
   EFI_PHYSICAL_ADDRESS  Handle;\r
-  CHAR8                 Token[DXE_PERFORMANCE_STRING_SIZE];  ///> Measured token string name \r
-  CHAR8                 Module[DXE_PERFORMANCE_STRING_SIZE]; ///> Module string name\r
-  UINT64                StartTimeStamp;                      ///> Start time point\r
-  UINT64                EndTimeStamp;                        ///> End time point\r
+  CHAR8                 Token[DXE_PERFORMANCE_STRING_SIZE];  ///< Measured token string name \r
+  CHAR8                 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name\r
+  UINT64                StartTimeStamp;                      ///< Start time point\r
+  UINT64                EndTimeStamp;                        ///< End time point\r
 } GAUGE_DATA_ENTRY;\r
 \r
 //\r
 // The header must be aligned at 8 bytes\r
 //\r
 typedef struct {\r
-  UINT32                NumberOfEntries; ///> The number of all performance gauge entries\r
+  UINT32                NumberOfEntries; ///< The number of all performance gauge entries\r
   UINT32                Reserved;\r
 } GAUGE_DATA_HEADER;\r
 \r

diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h
index 8ff64cb2c83126016cc7cc6aa7dccf3e11a7abc9..b1dcc283bdfff7cc505bf6cdd8cb60cde5da7498 100644 (file)
--- a/MdeModulePkg/Include/Guid/VariableFormat.h
+++ b/MdeModulePkg/Include/Guid/VariableFormat.h
@@ -146,15 +146,15 @@ typedef struct _VARIABLE_INFO_ENTRY  VARIABLE_INFO_ENTRY;
 /// This is an optional feature to dump all used variables in shell environment. \r
 ///\r
 struct _VARIABLE_INFO_ENTRY {\r
-  VARIABLE_INFO_ENTRY *Next;       ///> Pointer to next entry\r
-  EFI_GUID            VendorGuid;  ///> Guid of Variable \r
-  CHAR16              *Name;       ///> Name of Variable \r
-  UINT32              Attributes;  ///> Attributes of variable defined in UEFI spec\r
-  UINT32              ReadCount;   ///> Number of times to read this variable\r
-  UINT32              WriteCount;  ///> Number of times to write this variable\r
-  UINT32              DeleteCount; ///> Number of times to delete this variable\r
-  UINT32              CacheCount;  ///> Number of times that cache hits this variable\r
-  BOOLEAN             Volatile;    ///> TRUE if volatile, FALSE if non-volatile\r
+  VARIABLE_INFO_ENTRY *Next;       ///< Pointer to next entry\r
+  EFI_GUID            VendorGuid;  ///< Guid of Variable \r
+  CHAR16              *Name;       ///< Name of Variable \r
+  UINT32              Attributes;  ///< Attributes of variable defined in UEFI spec\r
+  UINT32              ReadCount;   ///< Number of times to read this variable\r
+  UINT32              WriteCount;  ///< Number of times to write this variable\r
+  UINT32              DeleteCount; ///< Number of times to delete this variable\r
+  UINT32              CacheCount;  ///< Number of times that cache hits this variable\r
+  BOOLEAN             Volatile;    ///< TRUE if volatile, FALSE if non-volatile\r
 };\r
 \r
 #endif // _EFI_VARIABLE_H_\r