tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-23 13:44:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Refine doxygen comments

Browse Source 
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8726 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2009-07-02 18:06:45 +00:00
parent 2bda59e494
commit 4a13fda739
4 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
MdeModulePkg/Include/Guid/CapsuleVendor.h
View File

@ -39,8 +39,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/// Data structure of capsule guid hob entry /// Data structure of capsule guid hob entry
/// ///
typedef struct { typedef struct {
EFI_PHYSICAL_ADDRESS BaseAddress; ///> Capsule data start address EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address
UINT32 Length; ///> Length of capsule data. UINT32 Length; ///< Length of capsule data.
} CAPSULE_HOB_INFO; } CAPSULE_HOB_INFO;
extern EFI_GUID gEfiCapsuleVendorGuid; extern EFI_GUID gEfiCapsuleVendorGuid;

4
MdeModulePkg/Include/Guid/MemoryTypeInformation.h
View File

@ -29,8 +29,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
extern EFI_GUID gEfiMemoryTypeInformationGuid; extern EFI_GUID gEfiMemoryTypeInformationGuid;
typedef struct { typedef struct {
UINT32 Type; ///> EFI memory type defined in UEFI specification. UINT32 Type; ///< EFI memory type defined in UEFI specification.
UINT32 NumberOfPages; ///> The pages of this type memory. UINT32 NumberOfPages; ///< The pages of this type memory.
} EFI_MEMORY_TYPE_INFORMATION; } EFI_MEMORY_TYPE_INFORMATION;
#endif #endif

20
MdeModulePkg/Include/Guid/Performance.h
View File

@ -26,17 +26,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct { typedef struct {
EFI_PHYSICAL_ADDRESS Handle; EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///> Measured token string name CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///> Module string name CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name
UINT64 StartTimeStamp; ///> Start time point UINT64 StartTimeStamp; ///< Start time point
UINT64 EndTimeStamp; ///> End time point UINT64 EndTimeStamp; ///< End time point
} PEI_PERFORMANCE_LOG_ENTRY; } PEI_PERFORMANCE_LOG_ENTRY;
// //
// The header must be aligned at 8 bytes. // The header must be aligned at 8 bytes.
// //
typedef struct { typedef struct {
UINT32 NumberOfEntries; ///> The number of all performance log entries UINT32 NumberOfEntries; ///< The number of all performance log entries
UINT32 Reserved; UINT32 Reserved;
} PEI_PERFORMANCE_LOG_HEADER; } PEI_PERFORMANCE_LOG_HEADER;
@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
typedef struct { typedef struct {
EFI_PHYSICAL_ADDRESS Handle; EFI_PHYSICAL_ADDRESS Handle;
CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///> Measured token string name CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///> Module string name CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name
UINT64 StartTimeStamp; ///> Start time point UINT64 StartTimeStamp; ///< Start time point
UINT64 EndTimeStamp; ///> End time point UINT64 EndTimeStamp; ///< End time point
} GAUGE_DATA_ENTRY; } GAUGE_DATA_ENTRY;
// //
// The header must be aligned at 8 bytes // The header must be aligned at 8 bytes
// //
typedef struct { typedef struct {
UINT32 NumberOfEntries; ///> The number of all performance gauge entries UINT32 NumberOfEntries; ///< The number of all performance gauge entries
UINT32 Reserved; UINT32 Reserved;
} GAUGE_DATA_HEADER; } GAUGE_DATA_HEADER;

18
MdeModulePkg/Include/Guid/VariableFormat.h
View File

@ -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. /// This is an optional feature to dump all used variables in shell environment.
/// ///
struct _VARIABLE_INFO_ENTRY { struct _VARIABLE_INFO_ENTRY {
VARIABLE_INFO_ENTRY *Next; ///> Pointer to next entry VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry
EFI_GUID VendorGuid; ///> Guid of Variable EFI_GUID VendorGuid; ///< Guid of Variable
CHAR16 *Name; ///> Name of Variable CHAR16 *Name; ///< Name of Variable
UINT32 Attributes; ///> Attributes of variable defined in UEFI spec UINT32 Attributes; ///< Attributes of variable defined in UEFI spec
UINT32 ReadCount; ///> Number of times to read this variable UINT32 ReadCount; ///< Number of times to read this variable
UINT32 WriteCount; ///> Number of times to write this variable UINT32 WriteCount; ///< Number of times to write this variable
UINT32 DeleteCount; ///> Number of times to delete this variable UINT32 DeleteCount; ///< Number of times to delete this variable
UINT32 CacheCount; ///> Number of times that cache hits this variable UINT32 CacheCount; ///< Number of times that cache hits this variable
BOOLEAN Volatile; ///> TRUE if volatile, FALSE if non-volatile BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile
}; };
#endif // _EFI_VARIABLE_H_ #endif // _EFI_VARIABLE_H_