tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Use doxygen comment style for document entity such as struct, enum, variable that use /// but not // 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5647 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-08-14 03:30:12 +00:00
parent ec8432e515
commit fc30687f39
17 changed files with 847 additions and 847 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
MdePkg/Include/Library/BaseLib.h
View File

@ -20,15 +20,15 @@
// These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER // These include SPIN_LOCK and BASE_LIBRARY_JUMP_BUFFER
// //
// ///
// SPIN_LOCK /// SPIN_LOCK
// ///
typedef volatile UINTN SPIN_LOCK; typedef volatile UINTN SPIN_LOCK;
#if defined (MDE_CPU_IA32) #if defined (MDE_CPU_IA32)
// ///
// IA32 context buffer used by SetJump() and LongJump() /// IA32 context buffer used by SetJump() and LongJump()
// ///
typedef struct { typedef struct {
UINT32 Ebx; UINT32 Ebx;
UINT32 Esi; UINT32 Esi;
@ -42,9 +42,9 @@ typedef struct {
#elif defined (MDE_CPU_IPF) #elif defined (MDE_CPU_IPF)
// ///
// IPF context buffer used by SetJump() and LongJump() /// IPF context buffer used by SetJump() and LongJump()
// ///
typedef struct { typedef struct {
UINT64 F2[2]; UINT64 F2[2];
UINT64 F3[2]; UINT64 F3[2];
@ -89,9 +89,9 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 0x10
#elif defined (MDE_CPU_X64) #elif defined (MDE_CPU_X64)
// ///
// X64 context buffer used by SetJump() and LongJump() /// X64 context buffer used by SetJump() and LongJump()
// ///
typedef struct { typedef struct {
UINT64 Rbx; UINT64 Rbx;
UINT64 Rsp; UINT64 Rsp;
@ -108,9 +108,9 @@ typedef struct {
#define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8 #define BASE_LIBRARY_JUMP_BUFFER_ALIGNMENT 8
#elif defined (MDE_CPU_EBC) #elif defined (MDE_CPU_EBC)
// ///
// EBC context buffer used by SetJump() and LongJump() /// EBC context buffer used by SetJump() and LongJump()
// ///
typedef struct { typedef struct {
UINT64 R0; UINT64 R0;
UINT64 R1; UINT64 R1;

6
MdePkg/Include/Library/DxeCoreEntryPoint.h
View File

@ -15,9 +15,9 @@
#ifndef __MODULE_ENTRY_POINT_H__ #ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__ #define __MODULE_ENTRY_POINT_H__
// ///
// Declare the cache of copy of HobList. /// Declare the cache of copy of HobList.
// ///
extern VOID *gHobList; extern VOID *gHobList;

6
MdePkg/Include/Library/DxeServicesTableLib.h
View File

@ -15,9 +15,9 @@
#ifndef __DXE_SERVICES_TABLE_LIB_H__ #ifndef __DXE_SERVICES_TABLE_LIB_H__
#define __DXE_SERVICES_TABLE_LIB_H__ #define __DXE_SERVICES_TABLE_LIB_H__
// ///
// Cache copy of the DXE Services Table /// Cache copy of the DXE Services Table
// ///
extern EFI_DXE_SERVICES *gDS; extern EFI_DXE_SERVICES *gDS;
#endif #endif

18
MdePkg/Include/Library/DxeSmmDriverEntryPoint.h
View File

@ -15,19 +15,19 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__ #ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__ #define __MODULE_ENTRY_POINT_H__
// ///
// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// Declare the EFI/UEFI Specification Revision to which this driver is implemented
// ///
extern const UINT32 _gUefiDriverRevision; extern const UINT32 _gUefiDriverRevision;
// ///
// Declare the number of entry points in the image. /// Declare the number of entry points in the image.
// ///
extern const UINT8 _gDriverEntryPointCount; extern const UINT8 _gDriverEntryPointCount;
// ///
// Declare the number of unload handler in the image. /// Declare the number of unload handler in the image.
// ///
extern const UINT8 _gDriverUnloadImageCount; extern const UINT8 _gDriverUnloadImageCount;
/** /**

8
MdePkg/Include/Library/HiiLib.h
View File

@ -15,10 +15,10 @@
#ifndef __HII_LIB_H__ #ifndef __HII_LIB_H__
#define __HII_LIB_H__ #define __HII_LIB_H__
// ///
// Limited buffer size recommended by RFC4646 (4.3. Length Considerations) /// Limited buffer size recommended by RFC4646 (4.3. Length Considerations)
// (42 characters plus a NULL terminator) /// (42 characters plus a NULL terminator)
// ///
#define RFC_3066_ENTRY_SIZE (42 + 1) #define RFC_3066_ENTRY_SIZE (42 + 1)
#define ISO_639_2_ENTRY_SIZE 3 #define ISO_639_2_ENTRY_SIZE 3

22
MdePkg/Include/Library/IfrSupportLib.h
View File

@ -63,21 +63,21 @@ typedef struct {
#pragma pack() #pragma pack()
typedef struct { typedef struct {
// ///
// Buffer size allocated for Data. /// Buffer size allocated for Data.
// ///
UINT32 BufferSize; UINT32 BufferSize;
// ///
// Offset in Data to append the newly created opcode binary. /// Offset in Data to append the newly created opcode binary.
// It will be adjusted automatically in Create***OpCode(), and should be /// It will be adjusted automatically in Create***OpCode(), and should be
// initialized to 0 before invocation of a serial of Create***OpCode() /// initialized to 0 before invocation of a serial of Create***OpCode()
// ///
UINT32 Offset; UINT32 Offset;
// ///
// The destination buffer for created op-codes /// The destination buffer for created op-codes
// ///
UINT8 *Data; UINT8 *Data;
} EFI_HII_UPDATE_DATA; } EFI_HII_UPDATE_DATA;

6
MdePkg/Include/Library/PcdLib.h
View File

@ -30,9 +30,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define PcdToken(TokenName) _PCD_TOKEN_##TokenName #define PcdToken(TokenName) _PCD_TOKEN_##TokenName
// ///
// Feature Flag is in the form of a global constant /// Feature Flag is in the form of a global constant
// ///
#define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName #define FeaturePcdGet(TokenName) _PCD_GET_MODE_BOOL_##TokenName

6
MdePkg/Include/Library/PeimEntryPoint.h
View File

@ -15,9 +15,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__ #ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__ #define __MODULE_ENTRY_POINT_H__
// ///
// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// Declare the EFI/UEFI Specification Revision to which this driver is implemented
// ///
extern const UINT32 _gPeimRevision; extern const UINT32 _gPeimRevision;
/** /**

6
MdePkg/Include/Library/PerformanceLib.h
View File

@ -15,9 +15,9 @@
#ifndef __PERFORMANCE_LIB_H__ #ifndef __PERFORMANCE_LIB_H__
#define __PERFORMANCE_LIB_H__ #define __PERFORMANCE_LIB_H__
// ///
// Performance library propery mask bits /// Performance library propery mask bits
// ///
#define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001 #define PERFORMANCE_LIBRARY_PROPERTY_MEASUREMENT_ENABLED 0x00000001
/** /**

10
MdePkg/Include/Library/ScsiLib.h
View File

@ -24,11 +24,11 @@
#define EFI_SCSI_STALL_1_MILLISECOND 10000 #define EFI_SCSI_STALL_1_MILLISECOND 10000
#define EFI_SCSI_STALL_1_SECOND 10000000 #define EFI_SCSI_STALL_1_SECOND 10000000
// ///
// this macro cannot be directly used by the gBS->Stall(), /// this macro cannot be directly used by the gBS->Stall(),
// since the value output by this macro is in 100ns unit, /// since the value output by this macro is in 100ns unit,
// not 1us unit (1us = 1000ns) /// not 1us unit (1us = 1000ns)
// ///
#define EfiScsiStallSeconds(a) ((a) * EFI_SCSI_STALL_1_SECOND) #define EfiScsiStallSeconds(a) ((a) * EFI_SCSI_STALL_1_SECOND)

6
MdePkg/Include/Library/SmbusLib.h
View File

@ -15,9 +15,9 @@
#ifndef __SMBUS_LIB__ #ifndef __SMBUS_LIB__
#define __SMBUS_LIB__ #define __SMBUS_LIB__
// ///
// PEC BIT is bit 22 in SMBUS address /// PEC BIT is bit 22 in SMBUS address
// ///
#define SMBUS_LIB_PEC_BIT (1 << 22) #define SMBUS_LIB_PEC_BIT (1 << 22)
/** /**

6
MdePkg/Include/Library/UefiApplicationEntryPoint.h
View File

@ -15,9 +15,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __UEFI_APPLICATION_ENTRY_POINT_H__ #ifndef __UEFI_APPLICATION_ENTRY_POINT_H__
#define __UEFI_APPLICATION_ENTRY_POINT_H__ #define __UEFI_APPLICATION_ENTRY_POINT_H__
// ///
// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// Declare the EFI/UEFI Specification Revision to which this driver is implemented
// ///
extern const UINT32 _gUefiDriverRevision; extern const UINT32 _gUefiDriverRevision;
/** /**

18
MdePkg/Include/Library/UefiBootServicesTableLib.h
View File

@ -15,19 +15,19 @@
#ifndef __UEFI_BOOT_SERVICES_TABLE_LIB_H__ #ifndef __UEFI_BOOT_SERVICES_TABLE_LIB_H__
#define __UEFI_BOOT_SERVICES_TABLE_LIB_H__ #define __UEFI_BOOT_SERVICES_TABLE_LIB_H__
// ///
// Cache the Image Handle /// Cache the Image Handle
// ///
extern EFI_HANDLE gImageHandle; extern EFI_HANDLE gImageHandle;
// ///
// Cache pointer to the EFI System Table /// Cache pointer to the EFI System Table
// ///
extern EFI_SYSTEM_TABLE *gST; extern EFI_SYSTEM_TABLE *gST;
// ///
// Cache pointer to the EFI Boot Services Table /// Cache pointer to the EFI Boot Services Table
// ///
extern EFI_BOOT_SERVICES *gBS; extern EFI_BOOT_SERVICES *gBS;
#endif #endif

30
MdePkg/Include/Library/UefiDriverEntryPoint.h
View File

@ -15,29 +15,29 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#ifndef __MODULE_ENTRY_POINT_H__ #ifndef __MODULE_ENTRY_POINT_H__
#define __MODULE_ENTRY_POINT_H__ #define __MODULE_ENTRY_POINT_H__
// ///
// Declare the EFI/UEFI Specification Revision to which this driver is implemented /// Declare the EFI/UEFI Specification Revision to which this driver is implemented
// ///
extern const UINT32 _gUefiDriverRevision; extern const UINT32 _gUefiDriverRevision;
// ///
// Declare the number of entry points in the image. /// Declare the number of entry points in the image.
// ///
extern const UINT8 _gDriverEntryPointCount; extern const UINT8 _gDriverEntryPointCount;
// ///
// Declare the number of unload handler in the image. /// Declare the number of unload handler in the image.
// ///
extern const UINT8 _gDriverUnloadImageCount; extern const UINT8 _gDriverUnloadImageCount;
// ///
// Declare the arrary of Boot Sevice Exit Event callbacks . /// Declare the arrary of Boot Sevice Exit Event callbacks .
// ///
extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[]; extern const EFI_EVENT_NOTIFY _gDriverExitBootServicesEvent[];
// ///
// Declare the arrary of Virtual Address Change Event callbacks . /// Declare the arrary of Virtual Address Change Event callbacks .
// ///
extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[]; extern const EFI_EVENT_NOTIFY _gDriverSetVirtualAddressMapEvent[];
/** /**

18
MdePkg/Include/Library/UefiLib.h
View File

@ -22,26 +22,26 @@
#include <Protocol/DriverDiagnostics.h> #include <Protocol/DriverDiagnostics.h>
#include <Protocol/DriverDiagnostics2.h> #include <Protocol/DriverDiagnostics2.h>
// ///
// Unicode String Table /// Unicode String Table
// ///
typedef struct { typedef struct {
CHAR8 *Language; CHAR8 *Language;
CHAR16 *UnicodeString; CHAR16 *UnicodeString;
} EFI_UNICODE_STRING_TABLE; } EFI_UNICODE_STRING_TABLE;
// ///
// EFI Lock Status /// EFI Lock Status
// ///
typedef enum { typedef enum {
EfiLockUninitialized = 0, EfiLockUninitialized = 0,
EfiLockReleased = 1, EfiLockReleased = 1,
EfiLockAcquired = 2 EfiLockAcquired = 2
} EFI_LOCK_STATE; } EFI_LOCK_STATE;
// ///
// EFI Lock /// EFI Lock
// ///
typedef struct { typedef struct {
EFI_TPL Tpl; EFI_TPL Tpl;
EFI_TPL OwnerTpl; EFI_TPL OwnerTpl;

6
MdePkg/Include/Library/UefiRuntimeServicesTableLib.h
View File

@ -15,9 +15,9 @@
#ifndef __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__ #ifndef __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__
#define __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__ #define __UEFI_RUNTIME_SERVICES_TABLE_LIB_H__
// ///
// Cached copy of the EFI Runtime Services Table /// Cached copy of the EFI Runtime Services Table
// ///
extern EFI_RUNTIME_SERVICES *gRT; extern EFI_RUNTIME_SERVICES *gRT;
#endif #endif

6
MdePkg/Include/Library/UsbLib.h
View File

@ -18,9 +18,9 @@
#include <Protocol/UsbIo.h> #include <Protocol/UsbIo.h>
// ///
// define the timeout time as 3ms /// define the timeout time as 3ms
// ///
#define TIMEOUT_VALUE 3 * 1000 #define TIMEOUT_VALUE 3 * 1000
/** /**