From 4a13fda7398e38bc8c17aa1afe01d6a74ec91809 Mon Sep 17 00:00:00 2001 From: klu2 Date: Thu, 2 Jul 2009 18:06:45 +0000 Subject: [PATCH] Refine doxygen comments git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8726 6f19259b-4bc3-4df7-8a09-765794883524 --- MdeModulePkg/Include/Guid/CapsuleVendor.h | 4 ++-- .../Include/Guid/MemoryTypeInformation.h | 4 ++-- MdeModulePkg/Include/Guid/Performance.h | 20 +++++++++---------- MdeModulePkg/Include/Guid/VariableFormat.h | 18 ++++++++--------- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h index ae77f1f6e5..d779e916ac 100644 --- 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 /// typedef struct { - EFI_PHYSICAL_ADDRESS BaseAddress; ///> Capsule data start address - UINT32 Length; ///> Length of capsule data. + EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address + UINT32 Length; ///< Length of capsule data. } CAPSULE_HOB_INFO; extern EFI_GUID gEfiCapsuleVendorGuid; diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h index 6143dc70dd..c37880a229 100644 --- 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; typedef struct { - UINT32 Type; ///> EFI memory type defined in UEFI specification. - UINT32 NumberOfPages; ///> The pages of this type memory. + UINT32 Type; ///< EFI memory type defined in UEFI specification. + UINT32 NumberOfPages; ///< The pages of this type memory. } EFI_MEMORY_TYPE_INFORMATION; #endif diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h index b59fe81040..de813da4b7 100644 --- 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. typedef struct { EFI_PHYSICAL_ADDRESS Handle; - CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///> Measured token string name - CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///> Module string name - UINT64 StartTimeStamp; ///> Start time point - UINT64 EndTimeStamp; ///> End time point + CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name + CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name + UINT64 StartTimeStamp; ///< Start time point + UINT64 EndTimeStamp; ///< End time point } PEI_PERFORMANCE_LOG_ENTRY; // // The header must be aligned at 8 bytes. // typedef struct { - UINT32 NumberOfEntries; ///> The number of all performance log entries + UINT32 NumberOfEntries; ///< The number of all performance log entries UINT32 Reserved; } PEI_PERFORMANCE_LOG_HEADER; @@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL; typedef struct { EFI_PHYSICAL_ADDRESS Handle; - CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///> Measured token string name - CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///> Module string name - UINT64 StartTimeStamp; ///> Start time point - UINT64 EndTimeStamp; ///> End time point + CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name + CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name + UINT64 StartTimeStamp; ///< Start time point + UINT64 EndTimeStamp; ///< End time point } GAUGE_DATA_ENTRY; // // The header must be aligned at 8 bytes // typedef struct { - UINT32 NumberOfEntries; ///> The number of all performance gauge entries + UINT32 NumberOfEntries; ///< The number of all performance gauge entries UINT32 Reserved; } GAUGE_DATA_HEADER; diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h index 8ff64cb2c8..b1dcc283bd 100644 --- 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. /// struct _VARIABLE_INFO_ENTRY { - VARIABLE_INFO_ENTRY *Next; ///> Pointer to next entry - EFI_GUID VendorGuid; ///> Guid of Variable - CHAR16 *Name; ///> Name of Variable - UINT32 Attributes; ///> Attributes of variable defined in UEFI spec - UINT32 ReadCount; ///> Number of times to read this variable - UINT32 WriteCount; ///> Number of times to write this variable - UINT32 DeleteCount; ///> Number of times to delete this variable - UINT32 CacheCount; ///> Number of times that cache hits this variable - BOOLEAN Volatile; ///> TRUE if volatile, FALSE if non-volatile + VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry + EFI_GUID VendorGuid; ///< Guid of Variable + CHAR16 *Name; ///< Name of Variable + UINT32 Attributes; ///< Attributes of variable defined in UEFI spec + UINT32 ReadCount; ///< Number of times to read this variable + UINT32 WriteCount; ///< Number of times to write this variable + UINT32 DeleteCount; ///< Number of times to delete this variable + UINT32 CacheCount; ///< Number of times that cache hits this variable + BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile }; #endif // _EFI_VARIABLE_H_