]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Use doxygen comment style for document entity such as struct, enum, variable that...
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 14 Aug 2008 04:29:48 +0000 (04:29 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 14 Aug 2008 04:29:48 +0000 (04:29 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5649 6f19259b-4bc3-4df7-8a09-765794883524

52 files changed:
MdePkg/Include/Protocol/AbsolutePointer.h
MdePkg/Include/Protocol/Bds.h
MdePkg/Include/Protocol/Bis.h
MdePkg/Include/Protocol/BlockIo.h
MdePkg/Include/Protocol/BusSpecificDriverOverride.h
MdePkg/Include/Protocol/ComponentName.h
MdePkg/Include/Protocol/ComponentName2.h
MdePkg/Include/Protocol/DebugPort.h
MdePkg/Include/Protocol/DebugSupport.h
MdePkg/Include/Protocol/DeviceIo.h
MdePkg/Include/Protocol/DevicePath.h
MdePkg/Include/Protocol/DevicePathFromText.h
MdePkg/Include/Protocol/DevicePathToText.h
MdePkg/Include/Protocol/DevicePathUtilities.h
MdePkg/Include/Protocol/DiskIo.h
MdePkg/Include/Protocol/DriverBinding.h
MdePkg/Include/Protocol/DriverConfiguration.h
MdePkg/Include/Protocol/DriverConfiguration2.h
MdePkg/Include/Protocol/DriverDiagnostics.h
MdePkg/Include/Protocol/DriverHealth.h
MdePkg/Include/Protocol/Ebc.h
MdePkg/Include/Protocol/FirmwareVolume2.h
MdePkg/Include/Protocol/HiiImage.h
MdePkg/Include/Protocol/LoadFile.h
MdePkg/Include/Protocol/LoadedImage.h
MdePkg/Include/Protocol/Metronome.h
MdePkg/Include/Protocol/Mtftp4.h
MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h
MdePkg/Include/Protocol/PciIo.h
MdePkg/Include/Protocol/PlatformDriverOverride.h
MdePkg/Include/Protocol/PxeBaseCode.h
MdePkg/Include/Protocol/PxeBaseCodeCallBack.h
MdePkg/Include/Protocol/RealTimeClock.h
MdePkg/Include/Protocol/Reset.h
MdePkg/Include/Protocol/Runtime.h
MdePkg/Include/Protocol/ScsiIo.h
MdePkg/Include/Protocol/ScsiPassThru.h
MdePkg/Include/Protocol/Security.h
MdePkg/Include/Protocol/SecurityPolicy.h
MdePkg/Include/Protocol/SerialIo.h
MdePkg/Include/Protocol/ServiceBinding.h
MdePkg/Include/Protocol/SimpleFileSystem.h
MdePkg/Include/Protocol/SimpleNetwork.h
MdePkg/Include/Protocol/SimpleTextIn.h
MdePkg/Include/Protocol/SimpleTextOut.h
MdePkg/Include/Protocol/Timer.h
MdePkg/Include/Protocol/UnicodeCollation.h
MdePkg/Include/Protocol/Usb2HostController.h
MdePkg/Include/Protocol/UsbHostController.h
MdePkg/Include/Protocol/Variable.h
MdePkg/Include/Protocol/VariableWrite.h
MdePkg/Include/Protocol/WatchdogTimer.h

index ca7ca6c820fc412f602c0041834bf3203c46b93f..2b8d94d49fbd5dee54e7013a5d6ded5bf67c1752 100644 (file)
@@ -73,14 +73,14 @@ typedef struct {
   UINT32 Attributes;\r
 } EFI_ABSOLUTE_POINTER_MODE;\r
 \r
-//\r
-// If set, indicates this device supports an alternate button input. \r
-// \r
+///\r
+/// If set, indicates this device supports an alternate button input. \r
+/// \r
 #define EFI_ABSP_SupportsAltActive    0x00000001\r
 \r
-//\r
-// If set, indicates this device returns pressure data in parameter CurrentZ.\r
-// \r
+///\r
+/// If set, indicates this device returns pressure data in parameter CurrentZ.\r
+/// \r
 #define EFI_ABSP_SupportsPressureAsZ  0x00000002\r
 \r
 \r
index 8bcfa93fac9da72e4b53a0a9c9a9482cf7e46801..843c5e9445be5d30cfb2f7b500420775754765be 100644 (file)
 #ifndef __ARCH_PROTOCOL_BDS_H__\r
 #define __ARCH_PROTOCOL_BDS_H__\r
 \r
-//\r
-// Global ID for the BDS Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the BDS Architectural Protocol\r
+///\r
 #define EFI_BDS_ARCH_PROTOCOL_GUID \\r
   { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
-//\r
-// Declare forward reference for the BDS Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the BDS Architectural Protocol\r
+///\r
 typedef struct _EFI_BDS_ARCH_PROTOCOL   EFI_BDS_ARCH_PROTOCOL;\r
 \r
 /**\r
index e01d049cbfaffe4208205c2d1576992867a2ea6f..eb4f7a60fcce1342ccd2f31fb35b1253c0676b54 100644 (file)
@@ -45,19 +45,19 @@ typedef VOID    *BIS_APPLICATION_HANDLE;
 typedef UINT16  BIS_ALG_ID;\r
 typedef UINT32  BIS_CERT_ID;\r
 \r
-//\r
-// EFI_BIS_DATA type.\r
-//\r
-// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r
-//\r
+///\r
+/// EFI_BIS_DATA type.\r
+///\r
+/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ).\r
+///\r
 typedef struct {\r
   UINT32  Length; // Length of Data in 8 bit bytes.\r
   UINT8   *Data;  // 32 Bit Flat Address of data.\r
 } EFI_BIS_DATA;\r
 \r
-//\r
-// EFI_BIS_VERSION type.\r
-//\r
+///\r
+/// EFI_BIS_VERSION type.\r
+///\r
 typedef struct {\r
   UINT32  Major;  // BIS Interface version number.\r
   UINT32  Minor;  // Build number.\r
@@ -72,53 +72,53 @@ typedef struct {
 #define BIS_CURRENT_VERSION_MAJOR BIS_VERSION_1\r
 #define BIS_VERSION_1             1\r
 \r
-//\r
-// EFI_BIS_SIGNATURE_INFO type.\r
-//\r
+///\r
+/// EFI_BIS_SIGNATURE_INFO type.\r
+///\r
 typedef struct {\r
   BIS_CERT_ID CertificateID;  // Truncated hash of platform Boot Object\r
-  //  authorization certificate.\r
-  //\r
+  ///  authorization certificate.\r
+  ///\r
   BIS_ALG_ID  AlgorithmID;  // A signature algorithm number.\r
   UINT16      KeyLength;    // Length of alg. keys in bits.\r
 } EFI_BIS_SIGNATURE_INFO;\r
 \r
-//\r
-// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
-// The exact numeric values come from\r
-//    "Common Data Security Architecture (CDSA) Specification".\r
-//\r
+///\r
+/// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID.\r
+/// The exact numeric values come from\r
+///    "Common Data Security Architecture (CDSA) Specification".\r
+///\r
 #define BIS_ALG_DSA     (41)  // CSSM_ALGID_DSA\r
 #define BIS_ALG_RSA_MD5 (42)  // CSSM_ALGID_MD5_WITH_RSA\r
-// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
-//\r
+/// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId.\r
+///\r
 #define BIS_CERT_ID_DSA     BIS_ALG_DSA     // CSSM_ALGID_DSA\r
 #define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA\r
-// The  following  is a mask value that gets applied to the truncated hash of a\r
-// platform  Boot Object Authorization Certificate to create the certificateID.\r
-// A certificateID must not have any bits set to the value 1 other than bits in\r
-// this mask.\r
-//\r
+/// The  following  is a mask value that gets applied to the truncated hash of a\r
+/// platform  Boot Object Authorization Certificate to create the certificateID.\r
+/// A certificateID must not have any bits set to the value 1 other than bits in\r
+/// this mask.\r
+///\r
 #define BIS_CERT_ID_MASK  (0xFF7F7FFF)\r
 \r
-//\r
-// Macros for dealing with the EFI_BIS_DATA object obtained\r
-// from BIS_GetSignatureInfo()\r
-// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO\r
-//  elements are contained in a EFI_BIS_DATA struct pointed to\r
-//  by the provided EFI_BIS_DATA*.\r
-//\r
+///\r
+/// Macros for dealing with the EFI_BIS_DATA object obtained\r
+/// from BIS_GetSignatureInfo()\r
+/// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO\r
+///  elements are contained in a EFI_BIS_DATA struct pointed to\r
+///  by the provided EFI_BIS_DATA*.\r
+///\r
 #define BIS_GET_SIGINFO_COUNT(BisDataPtr) ((BisDataPtr)->Length / sizeof (EFI_BIS_SIGNATURE_INFO))\r
 \r
-//\r
-// BIS_GET_SIGINFO_ARRAY - produces a EFI_BIS_SIGNATURE_INFO*\r
-//  from a given EFI_BIS_DATA*.\r
-//\r
+///\r
+/// BIS_GET_SIGINFO_ARRAY - produces a EFI_BIS_SIGNATURE_INFO*\r
+///  from a given EFI_BIS_DATA*.\r
+///\r
 #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data)\r
 \r
-//\r
-// Support old name for backward compatible\r
-//\r
+///\r
+/// Support old name for backward compatible\r
+///\r
 #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \\r
         BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID\r
 \r
index ecfd3a7551320ff44f5f7bd733b3cd08c2a8b6a2..32fe4ef41fb89ca8a37f112683d8853cc6e491dd 100644 (file)
 \r
 typedef struct _EFI_BLOCK_IO_PROTOCOL  EFI_BLOCK_IO_PROTOCOL;\r
 \r
-//\r
-// Protocol GUID name defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
 #define BLOCK_IO_PROTOCOL       EFI_BLOCK_IO_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_BLOCK_IO_PROTOCOL   EFI_BLOCK_IO;\r
 \r
 /**\r
index 14d24d31c44fdf2c1d508f94c3e23263e259f0db..1f86c315fb5c6bb6b3a9eadf6556111837baa7e0 100644 (file)
@@ -20,9 +20,9 @@
 #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
 #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_\r
 \r
-//\r
-// Global ID for the Bus Specific Driver Override Protocol\r
-//\r
+///\r
+/// Global ID for the Bus Specific Driver Override Protocol\r
+///\r
 #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \\r
index 7ac7ce0a31e088a18f3ae15694b36286666d7cd3..3568c057addb1af82e0658f3a9c45f21bcec5133 100644 (file)
@@ -19,9 +19,9 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the Component Name Protocol\r
-//\r
+///\r
+/// Global ID for the Component Name Protocol\r
+///\r
 #define EFI_COMPONENT_NAME_PROTOCOL_GUID \\r
   { \\r
     0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
index 7cec01699e0178955c4de48681b6ae7e5a2036ae..a9562474afecb1711c8d2a2b714200f06b6e47e2 100644 (file)
@@ -19,9 +19,9 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the Component Name Protocol\r
-//\r
+///\r
+/// Global ID for the Component Name Protocol\r
+///\r
 #define EFI_COMPONENT_NAME2_PROTOCOL_GUID \\r
   {0x6a7a5cff, 0xe8d9, 0x4f70, { 0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14 } }\r
 \r
index 265c47abbe21386072b03d917de440201aa360a0..edfae57367304efbdfaae5fa5602e9b472aefb4d 100644 (file)
@@ -19,9 +19,9 @@
 #define __DEBUG_PORT_H__\r
 \r
 \r
-//\r
-// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}\r
-//\r
+///\r
+/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}\r
+///\r
 #define EFI_DEBUGPORT_PROTOCOL_GUID \\r
   { \\r
     0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \\r
index 1fa4843ecdaccd712b3b699e91ff3b1bc12f6479..79ec7dbdf6a2027e6bfed9a7bfcc4d5c45ff09ec 100644 (file)
 \r
 typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL;\r
 \r
-//\r
-// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}\r
-//\r
+///\r
+/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}\r
+///\r
 #define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \\r
   { \\r
     0x2755590C, 0x6F3C, 0x42FA, {0x9E, 0xA4, 0xA3, 0xBA, 0x54, 0x3C, 0xDA, 0x25 } \\r
   }\r
 \r
-//\r
-// Debug Support definitions\r
-//\r
+///\r
+/// Debug Support definitions\r
+///\r
 typedef INTN  EFI_EXCEPTION_TYPE;\r
 \r
 //\r
@@ -448,14 +448,14 @@ typedef struct {
 #define EXCEPT_EBC_INSTRUCTION_ENCODING 8   // malformed instruction\r
 #define EXCEPT_EBC_BAD_BREAK            9   // BREAK 0 or undefined BREAK\r
 #define EXCEPT_EBC_STEP                 10  // to support debug stepping\r
-//\r
-// For coding convenience, define the maximum valid EBC exception.\r
-//\r
+///\r
+/// For coding convenience, define the maximum valid EBC exception.\r
+///\r
 #define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP\r
 \r
-//\r
-//  EBC processor context definition\r
-//\r
+///\r
+///  EBC processor context definition\r
+///\r
 typedef struct {\r
   UINT64  R0;\r
   UINT64  R1;\r
@@ -470,9 +470,9 @@ typedef struct {
   UINT64  Ip;\r
 } EFI_SYSTEM_CONTEXT_EBC;\r
 \r
-//\r
-// Universal EFI_SYSTEM_CONTEXT definition\r
-//\r
+///\r
+/// Universal EFI_SYSTEM_CONTEXT definition\r
+///\r
 typedef union {\r
   EFI_SYSTEM_CONTEXT_EBC  *SystemContextEbc;\r
   EFI_SYSTEM_CONTEXT_IA32 *SystemContextIa32;\r
index 0bc4394904750d14c878b21a7ff9ff93ad29694c..7b79d2355f13e7b423a445d1954c5eba79b91343 100644 (file)
 \r
 typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL;\r
 \r
-//\r
-// Protocol GUID name defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
 #define DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_DEVICE_IO_PROTOCOL  EFI_DEVICE_IO_INTERFACE;\r
 \r
 typedef enum {\r
index fddf972bef8bdc399c9776089934f5c964c145c1..48c8f4b77bb05c42ca245c393f6b418e2ff015ea 100644 (file)
@@ -21,9 +21,9 @@
 \r
 #include <Guid/PcAnsi.h>\r
 \r
-//\r
-// Device Path protocol\r
-//\r
+///\r
+/// Device Path protocol\r
+///\r
 #define EFI_DEVICE_PATH_PROTOCOL_GUID \\r
   { \\r
     0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
@@ -33,9 +33,9 @@
 // Protocol GUID defined in EFI1.1.\r
 // \r
 \r
-//\r
-// Device Path information\r
-//\r
+///\r
+/// Device Path information\r
+///\r
 #define DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH_PROTOCOL_GUID\r
 \r
 #pragma pack(1)\r
@@ -46,14 +46,14 @@ typedef struct {
   UINT8 Length[2];\r
 } EFI_DEVICE_PATH_PROTOCOL;\r
 \r
-//\r
-// For backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// For backward-compatible with EFI1.1.\r
+/// \r
 typedef EFI_DEVICE_PATH_PROTOCOL  EFI_DEVICE_PATH;\r
 \r
-//\r
-// Hardware Device Paths\r
-//\r
+///\r
+/// Hardware Device Paths\r
+///\r
 #define HARDWARE_DEVICE_PATH      0x01\r
 \r
 #define HW_PCI_DP                 0x01\r
@@ -89,9 +89,9 @@ typedef struct {
   UINT32                          ControllerNumber;\r
 } CONTROLLER_DEVICE_PATH;\r
 \r
-//\r
-// ACPI Device Paths\r
-//\r
+///\r
+/// ACPI Device Paths\r
+///\r
 #define ACPI_DEVICE_PATH          0x02\r
 \r
 #define ACPI_DP                   0x01\r
@@ -107,10 +107,10 @@ typedef struct {
   UINT32                          HID;\r
   UINT32                          UID;\r
   UINT32                          CID;\r
-  //\r
-  // Optional variable length _HIDSTR\r
-  // Optional variable length _UIDSTR\r
-  //\r
+  ///\r
+  /// Optional variable length _HIDSTR\r
+  /// Optional variable length _UIDSTR\r
+  ///\r
 } ACPI_EXTENDED_HID_DEVICE_PATH;\r
 \r
 //\r
@@ -151,9 +151,9 @@ typedef struct {
                       (((_Port)           & 0xf) << 4)  |  \\r
                        ((_Index)          & 0xf) ))\r
 \r
-//\r
-// Messaging Device Paths\r
-//\r
+///\r
+/// Messaging Device Paths\r
+///\r
 #define MESSAGING_DEVICE_PATH     0x03\r
 \r
 #define MSG_ATAPI_DP              0x01\r
@@ -426,9 +426,9 @@ typedef struct {
 #define BBS_TYPE_UNKNOWN          0xFF\r
 \r
 \r
-//\r
-// Union of all possible Device Paths and pointers to Device Paths\r
-//\r
+///\r
+/// Union of all possible Device Paths and pointers to Device Paths\r
+///\r
 \r
 typedef union {\r
   EFI_DEVICE_PATH_PROTOCOL             DevPath;\r
index 5caf5dff056c7afa49a526cd40e4d23a0ce851f6..d00614b21d0c6eb51be8679eaf06ebb1a126220d 100644 (file)
@@ -18,9 +18,9 @@
 \r
 #include <Protocol/DevicePath.h>\r
 \r
-//\r
-// Device Path From Text protocol\r
-//\r
+///\r
+/// Device Path From Text protocol\r
+///\r
 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \\r
   { \\r
     0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e  } \\r
index bf043e09a9cc257159bbea3badfeea13798ed857..8e03c7f2fb83f4c3bcb8eeb31a7581ac72ed3166 100644 (file)
@@ -18,9 +18,9 @@
 \r
 #include <Protocol/DevicePath.h>\r
 \r
-//\r
-// Device Path To Text protocol\r
-//\r
+///\r
+/// Device Path To Text protocol\r
+///\r
 #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \\r
   { \\r
     0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } \\r
index 7a8c50934e1bf1a863869c8bf19004978dea4659..830f52e5c573a212ebbe3ab1ebff01e28c622262 100644 (file)
@@ -19,9 +19,9 @@
 \r
 #include <Protocol/DevicePath.h>\r
 \r
-//\r
-// Device Path Utilities protocol\r
-//\r
+///\r
+/// Device Path Utilities protocol\r
+///\r
 #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \\r
   { \\r
     0x379be4e, 0xd706, 0x437d, {0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } \\r
index 2f15b705540f49548fad9482e68b56ab103805a2..a9f1b96032f300fa0c1ef486786cc956e3b00348 100644 (file)
     0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// Protocol GUID name defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
 #define DISK_IO_PROTOCOL  EFI_DISK_IO_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_DISK_IO_PROTOCOL  EFI_DISK_IO;\r
 \r
 /**\r
@@ -95,9 +95,9 @@ EFI_STATUS
 \r
 #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000\r
 \r
-//\r
-// Revision defined in EFI1.1\r
-// \r
+///\r
+/// Revision defined in EFI1.1\r
+/// \r
 #define EFI_DISK_IO_INTERFACE_REVISION  EFI_DISK_IO_PROTOCOL_REVISION\r
 \r
 /**\r
index 689c1a0a88c1611fc5c3633be551697a84022057..7e0cbbda5862ea275a96245cb7973165138aeada 100644 (file)
@@ -20,9 +20,9 @@
 \r
 #include <PiDxe.h>\r
 #include <Protocol/DevicePath.h>\r
-//\r
-// Global ID for the ControllerHandle Driver Protocol\r
-//\r
+///\r
+/// Global ID for the ControllerHandle Driver Protocol\r
+///\r
 #define EFI_DRIVER_BINDING_PROTOCOL_GUID \\r
   { \\r
     0x18a031ab, 0xb443, 0x4d1a, {0xa5, 0xc0, 0xc, 0x9, 0x26, 0x1e, 0x9f, 0x71 } \\r
index c7a275213236c94c4d368a4cfd425dac11807a0c..ce94de7f8b902ff108fdac87d5a403aa72e14522 100644 (file)
@@ -18,9 +18,9 @@
 #include <PiDxe.h>\r
 #include <Protocol/DriverConfiguration2.h>\r
 \r
-//\r
-// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
-//\r
+///\r
+/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
+///\r
 #define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \\r
   { \\r
     0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
index 201599c98f449335caad442a257473b882a359b9..2d287d66f488e67c9360a7e8f5ddfa643a4498b0 100644 (file)
@@ -17,9 +17,9 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
-//\r
+///\r
+/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0\r
+///\r
 #define EFI_DRIVER_CONFIGURATION2_PROTOCOL_GUID \\r
   { \\r
     0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe } \\r
index 0751202153b911e3b831f497ca301b2517c1ad35..d8cddd963f325c0fa5bd18f37e4ac12ec81a1248 100644 (file)
@@ -17,9 +17,9 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.\r
-//\r
+///\r
+/// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0.\r
+///\r
 #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \\r
   { \\r
     0x0784924f, 0xe296, 0x11d4, {0x9a, 0x49, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
index d177c8d89030ebe6d00e7321e5359f5895a2011e..2b889023f543986c0de9f40d4b385f29c39a6b23 100644 (file)
@@ -22,9 +22,9 @@
   \r
 typedef struct _EFI_DRIVER_HEALTH_PROTOCOL  EFI_DRIVER_HEALTH_PROTOCOL;\r
 \r
-//\r
-// EFI_DRIVER_HEALTH_HEALTH_STATUS\r
-//\r
+///\r
+/// EFI_DRIVER_HEALTH_HEALTH_STATUS\r
+///\r
 typedef enum {\r
   EfiDriverHealthStatusHealthy,\r
   EfiDriverHealthStatusRepairRequired,\r
@@ -34,9 +34,9 @@ typedef enum {
   EfiDriverHealthStatusRebootRequired\r
 } EFI_DRIVER_HEALTH_HEALTH_STATUS;\r
 \r
-//\r
-// EFI_DRIVER_HEALTH_HII_MESSAGE\r
-//\r
+///\r
+/// EFI_DRIVER_HEALTH_HII_MESSAGE\r
+///\r
 typedef struct {\r
   EFI_HII_HANDLE  HiiHandle;\r
   EFI_STRING_ID   StringId;\r
index 7710b2144e086502b6e8d4e49b5c9b7262a97096..01b425588342d1cd1f565a857ea515e81c25d6d4 100644 (file)
     0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \\r
   }\r
 \r
-//\r
-// Protocol Guid Name defined in spec.\r
-//\r
+///\r
+/// Protocol Guid Name defined in spec.\r
+///\r
 #define EFI_EBC_PROTOCOL_GUID EFI_EBC_INTERPRETER_PROTOCOL_GUID\r
 \r
-//\r
-// Define for forward reference.\r
-//\r
+///\r
+/// Define for forward reference.\r
+///\r
 typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL;\r
 \r
 /**\r
index fd07c95f55a93466ada38ac56f284972d4f05aa1..1d22bbeeeaa694def994a3f81b5372d78bbad41e 100644 (file)
@@ -28,9 +28,9 @@
 typedef struct _EFI_FIRMWARE_VOLUME2_PROTOCOL EFI_FIRMWARE_VOLUME2_PROTOCOL;\r
 \r
 \r
-//\r
-// EFI_FV_ATTRIBUTES\r
-//\r
+///\r
+/// EFI_FV_ATTRIBUTES\r
+///\r
 typedef UINT64  EFI_FV_ATTRIBUTES;\r
 \r
 //\r
index a9da9e66882ab76d894840f5131b29dc4421d27c..0cc6445d779dc4ede658efbc08660ebe7513ef37 100644 (file)
@@ -21,9 +21,9 @@
 typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;\r
 \r
 \r
-//\r
-// Flags in EFI_IMAGE_INPUT\r
-// \r
+///\r
+/// Flags in EFI_IMAGE_INPUT\r
+/// \r
 #define EFI_IMAGE_TRANSPARENT 0x00000001\r
 \r
 /**\r
index c2867f49373f6a3a8c4a58d2eeec4aaeb8b7417b..8ee5128277d0e0fdd95fce2ac30af429b7aeb870 100644 (file)
     0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \\r
   }\r
 \r
-//\r
-// Protocol Guid defined by EFI1.1.\r
-//\r
+///\r
+/// Protocol Guid defined by EFI1.1.\r
+///\r
 #define LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL;\r
 \r
-//\r
-// Backward-compatible with EFI1.1\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1\r
+/// \r
 typedef EFI_LOAD_FILE_PROTOCOL  EFI_LOAD_FILE_INTERFACE;\r
 \r
 /**\r
index f87011930b98cf31dcf43b44938c2f73e78b0af8..ecf182662477ea43e4fea691a70e595ece13c804 100644 (file)
     0xbc62157e, 0x3e33, 0x4fec, {0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define LOADED_IMAGE_PROTOCOL   EFI_LOADED_IMAGE_PROTOCOL_GUID\r
 \r
-//\r
-// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h\r
-//\r
+///\r
+/// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h\r
+///\r
 #define EFI_LOADED_IMAGE_PROTOCOL_REVISION  0x1000\r
 \r
-//\r
-// Revision defined in EFI1.1.\r
-// \r
+///\r
+/// Revision defined in EFI1.1.\r
+/// \r
 #define EFI_LOADED_IMAGE_INFORMATION_REVISION    EFI_LOADED_IMAGE_PROTOCOL_REVISION\r
 \r
 /**  \r
index edc4927d35c8402ae7a1dafd04011104d00f8252..41fde89ad23e11dd7b5efcca37ad94f933b8698e 100644 (file)
 #ifndef __ARCH_PROTOCOL_METRONOME_H__\r
 #define __ARCH_PROTOCOL_METRONOME_H__\r
 \r
-//\r
-// Global ID for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Metronome Architectural Protocol\r
+///\r
 #define EFI_METRONOME_ARCH_PROTOCOL_GUID \\r
   { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
 \r
-//\r
-// Declare forward reference for the Metronome Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Metronome Architectural Protocol\r
+///\r
 typedef struct _EFI_METRONOME_ARCH_PROTOCOL   EFI_METRONOME_ARCH_PROTOCOL;\r
 \r
 /**\r
index 4191227e9f47883fe598377fdb8669c106334a63..62d8e8d41ff712d97d262e700f221b49f566d9ab 100644 (file)
@@ -111,9 +111,9 @@ typedef union {
 \r
 #pragma pack()\r
 \r
-//\r
-// MTFTP4 option definition\r
-//\r
+///\r
+/// MTFTP4 option definition\r
+///\r
 typedef struct {\r
   UINT8                   *OptionStr;\r
   UINT8                   *ValueStr;\r
index c6514c173db4b853a6f98cc4ed4fcadbbfc77ea1..bb3b9a3905713eff203bd50fbd11957dcccc8476 100644 (file)
 \r
 #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION    0x00010000\r
 \r
-//\r
-// Revision defined in EFI1.1.\r
-// \r
+///\r
+/// Revision defined in EFI1.1.\r
+/// \r
 #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION   EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL  EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL   EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE;\r
 \r
 typedef enum {\r
index 09d0ea7773b0d0a939e70e65f5da02e4c459f37b..286d42309934ac096f1fbe21b07fc489d6dd5178 100644 (file)
@@ -16,9 +16,9 @@
 #ifndef __PCI_IO_H__\r
 #define __PCI_IO_H__\r
 \r
-//\r
-// Global ID for the PCI I/O Protocol\r
-//\r
+///\r
+/// Global ID for the PCI I/O Protocol\r
+///\r
 #define EFI_PCI_IO_PROTOCOL_GUID \\r
   { \\r
     0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a } \\r
@@ -26,9 +26,9 @@
 \r
 typedef struct _EFI_PCI_IO_PROTOCOL  EFI_PCI_IO_PROTOCOL;\r
 \r
-//\r
-// Prototypes for the PCI I/O Protocol\r
-//\r
+///\r
+/// Prototypes for the PCI I/O Protocol\r
+///\r
 typedef enum {\r
   EfiPciIoWidthUint8      = 0,\r
   EfiPciIoWidthUint16,\r
@@ -73,11 +73,11 @@ typedef enum {
 #define EFI_PCI_DEVICE_ENABLE                     (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER)\r
 #define EFI_VGA_DEVICE_ENABLE                     (EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY | EFI_PCI_IO_ATTRIBUTE_VGA_IO | EFI_PCI_IO_ATTRIBUTE_IO)\r
 \r
-//\r
-// *******************************************************\r
-// EFI_PCI_IO_PROTOCOL_OPERATION\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PCI_IO_PROTOCOL_OPERATION\r
+/// *******************************************************\r
+///\r
 typedef enum {\r
   EfiPciIoOperationBusMasterRead,\r
   EfiPciIoOperationBusMasterWrite,\r
@@ -85,11 +85,11 @@ typedef enum {
   EfiPciIoOperationMaximum\r
 } EFI_PCI_IO_PROTOCOL_OPERATION;\r
 \r
-//\r
-// *******************************************************\r
-// EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION\r
-// *******************************************************\r
-//\r
+///\r
+/// *******************************************************\r
+/// EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION\r
+/// *******************************************************\r
+///\r
 typedef enum {\r
   EfiPciIoAttributeOperationGet,\r
   EfiPciIoAttributeOperationSet,\r
index 71e2a518978cc59f2a732781fd2838644bcac83f..1fa2522c758658a3b26101cedf675d6e3030394b 100644 (file)
@@ -15,9 +15,9 @@
 #ifndef __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__\r
 #define __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__\r
 \r
-//\r
-// Global ID for the Platform Driver Override Protocol\r
-//\r
+///\r
+/// Global ID for the Platform Driver Override Protocol\r
+///\r
 #define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \\r
   { \\r
     0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
index c341d46aeca6e1b04f900b2deefe6359b1afd4a4..4958cdfb1f6c9263d680112ae133bc833f56995f 100644 (file)
@@ -15,9 +15,9 @@
 #ifndef __PXE_BASE_CODE_PROTOCOL_H__\r
 #define __PXE_BASE_CODE_PROTOCOL_H__\r
 \r
-//\r
-// PXE Base Code protocol\r
-//\r
+///\r
+/// PXE Base Code protocol\r
+///\r
 #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \\r
   { \\r
     0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \\r
 \r
 typedef struct _EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_PXE_BASE_CODE_PROTOCOL  EFI_PXE_BASE_CODE;\r
 \r
-//\r
-// Default IP TTL and ToS.\r
-//\r
+///\r
+/// Default IP TTL and ToS.\r
+///\r
 #define DEFAULT_TTL 16\r
 #define DEFAULT_ToS 0\r
 \r
-//\r
-// ICMP error format\r
-//\r
+///\r
+/// ICMP error format\r
+///\r
 typedef struct {\r
   UINT8   Type;\r
   UINT8   Code;\r
@@ -55,17 +55,17 @@ typedef struct {
   UINT8 Data[494];\r
 } EFI_PXE_BASE_CODE_ICMP_ERROR;\r
 \r
-//\r
-// TFTP error format\r
-//\r
+///\r
+/// TFTP error format\r
+///\r
 typedef struct {\r
   UINT8 ErrorCode;\r
   CHAR8 ErrorString[127];\r
 } EFI_PXE_BASE_CODE_TFTP_ERROR;\r
 \r
-//\r
-// IP Receive Filter definitions\r
-//\r
+///\r
+/// IP Receive Filter definitions\r
+///\r
 #define EFI_PXE_BASE_CODE_MAX_IPCNT 8\r
 \r
 typedef struct {\r
@@ -80,9 +80,9 @@ typedef struct {
 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS           0x0004\r
 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008\r
 \r
-//\r
-// ARP Cache definitions\r
-//\r
+///\r
+/// ARP Cache definitions\r
+///\r
 typedef struct {\r
   EFI_IP_ADDRESS  IpAddr;\r
   EFI_MAC_ADDRESS MacAddr;\r
@@ -136,9 +136,9 @@ typedef UINT16  EFI_PXE_BASE_CODE_UDP_PORT;
 #define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK     0x7FFF\r
 #define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL  0x0000\r
 \r
-//\r
-// Discover() server list structure.\r
-//\r
+///\r
+/// Discover() server list structure.\r
+///\r
 typedef struct {\r
   UINT16          Type;\r
   BOOLEAN         AcceptAnyResponse;\r
@@ -146,9 +146,9 @@ typedef struct {
   EFI_IP_ADDRESS  IpAddr;\r
 } EFI_PXE_BASE_CODE_SRVLIST;\r
 \r
-//\r
-// Discover() information override structure.\r
-//\r
+///\r
+/// Discover() information override structure.\r
+///\r
 typedef struct {\r
   BOOLEAN                   UseMCast;\r
   BOOLEAN                   UseBCast;\r
@@ -159,9 +159,9 @@ typedef struct {
   EFI_PXE_BASE_CODE_SRVLIST SrvList[1];\r
 } EFI_PXE_BASE_CODE_DISCOVER_INFO;\r
 \r
-//\r
-// Mtftp() definitions\r
-//\r
+///\r
+/// Mtftp() definitions\r
+///\r
 typedef enum {\r
   EFI_PXE_BASE_CODE_TFTP_FIRST,\r
   EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,\r
index 0745d7c655c30ec7c0d79018fdcccb76fa9aeeea..b79eaf9a63db77b5b76533161ff1bf7c67b79627 100644 (file)
@@ -17,9 +17,9 @@
 #ifndef _PXE_BASE_CODE_CALLBACK_H_\r
 #define _PXE_BASE_CODE_CALLBACK_H_\r
 \r
-//\r
-// Call Back Definitions\r
-//\r
+///\r
+/// Call Back Definitions\r
+///\r
 #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \\r
   { \\r
     0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
 #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION  \\r
         EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION\r
 \r
-//\r
-// Protocol definition\r
-//\r
+///\r
+/// Protocol definition\r
+///\r
 typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL  EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL;\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL   EFI_PXE_BASE_CODE_CALLBACK;\r
 \r
 typedef enum {\r
index d25bb75145dd33dde619ae8607359e7b9da1c5b6..3de3d28afa1be3266db7fe9697f20056ec5b126f 100644 (file)
@@ -25,9 +25,9 @@
 #ifndef __ARCH_PROTOCOL_REAL_TIME_CLOCK_H__\r
 #define __ARCH_PROTOCOL_REAL_TIME_CLOCK_H__\r
 \r
-//\r
-// Global ID for the Real Time Clock Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Real Time Clock Architectural Protocol\r
+///\r
 #define EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID \\r
   { 0x27CFAC87, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
index aa7ed3f490f48ac6dd6efe8752cc3a48d58096f5..c82a92c87fffc15cca4c2b9521e13e51cecec5eb 100644 (file)
@@ -22,9 +22,9 @@
 #ifndef __ARCH_PROTOCOL_RESET_H__\r
 #define __ARCH_PROTOCOL_RESET_H__\r
 \r
-//\r
-// Global ID for the Reset Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Reset Architectural Protocol\r
+///\r
 #define EFI_RESET_ARCH_PROTOCOL_GUID  \\r
   { 0x27CFAC88, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
index 5fb8aee7ca75ab257bd47909e89ed538300d627b..32c3359af84d7dcc63bb09eb689cc630a01ec56b 100644 (file)
 #ifndef __ARCH_PROTOCOL_RUNTIME_H__\r
 #define __ARCH_PROTOCOL_RUNTIME_H__\r
 \r
-//\r
-// Global ID for the Runtime Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Runtime Architectural Protocol\r
+///\r
 #define EFI_RUNTIME_ARCH_PROTOCOL_GUID \\r
   { 0xb7dfb4e1, 0x52f, 0x449f, {0x87, 0xbe, 0x98, 0x18, 0xfc, 0x91, 0xb7, 0x33 } }\r
 \r
 typedef struct _EFI_RUNTIME_ARCH_PROTOCOL  EFI_RUNTIME_ARCH_PROTOCOL;\r
 \r
-//\r
-// LIST_ENTRY from BaseType \r
-//\r
+///\r
+/// LIST_ENTRY from BaseType \r
+///\r
 typedef LIST_ENTRY EFI_LIST_ENTRY;\r
 \r
 typedef struct _EFI_RUNTIME_IMAGE_ENTRY  EFI_RUNTIME_IMAGE_ENTRY;\r
index 030a06229d3677e6ad547dba7d5009b8e719a808..6437efb55e06fa47ce5eab7b345b11e13976a6df 100644 (file)
@@ -23,9 +23,9 @@
     0x932f4736, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \\r
   }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL;\r
 \r
 //\r
index 2192e9bf4951c36416389d136454bc42c77db3ea..f40619311817392f832333566089a7a8d811d4a3 100644 (file)
@@ -27,9 +27,9 @@
     0xa59e8fcf, 0xbda0, 0x43bb, {0x90, 0xb1, 0xd3, 0x73, 0x2e, 0xca, 0xa8, 0x77 } \\r
   }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_SCSI_PASS_THRU_PROTOCOL  EFI_SCSI_PASS_THRU_PROTOCOL;\r
 \r
 #define EFI_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL    0x0001\r
index 9d8c007127d23bd143dafd9db0c733baefbe4ddf..c79c3dc52c93ca81e6bfb92c62a51d398885bb17 100644 (file)
@@ -30,9 +30,9 @@
 \r
 #include <PiDxe.h>\r
 \r
-//\r
-// Global ID for the Security Code Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Security Code Architectural Protocol\r
+///\r
 #define EFI_SECURITY_ARCH_PROTOCOL_GUID  \\r
   { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } }\r
 \r
index b9f2ff024f722fd842659ed78f89bc5015fa2dbd..93dd702a4bc64fb2a735e58a0d7a747befaff766 100644 (file)
@@ -15,9 +15,9 @@
 #ifndef _SECURITY_POLICY_H_\r
 #define _SECURITY_POLICY_H_\r
 \r
-//\r
-// Security policy protocol GUID definition\r
-//\r
+///\r
+/// Security policy protocol GUID definition\r
+///\r
 #define EFI_SECURITY_POLICY_PROTOCOL_GUID  \\r
   {0x78E4D245, 0xCD4D, 0x4a05, {0xA2, 0xBA, 0x47, 0x43, 0xE8, 0x6C, 0xFC, 0xAB} }\r
 \r
index 3cffd930e5e165bb00f8c5583b1aad83253c93fc..cf73f87708623b1a5e4866db4beb93979de7b739 100644 (file)
     0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;\r
 \r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;\r
 \r
-//\r
-// Serial IO Data structures\r
-//\r
+///\r
+/// Serial IO Data structures\r
+///\r
 typedef enum {\r
   DefaultParity,\r
   NoParity,\r
index c0b5e832321c733c1abf0f57abf7b38987766973..5f37727d6e7907787768a6d27ba9b2c452855577 100644 (file)
@@ -18,9 +18,9 @@
 #ifndef __EFI_SERVICE_BINDING_H__\r
 #define __EFI_SERVICE_BINDING_H__\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL;\r
 \r
 /**\r
index dfc8bc31fb1b6ec5a04efd6dcfeec971e3958211..feead3fb1a2f81b0c2627fd91c88f1327fd4edd2 100644 (file)
@@ -32,14 +32,14 @@ typedef struct _EFI_FILE_PROTOCOL         EFI_FILE_PROTOCOL;
 typedef struct _EFI_FILE_PROTOCOL         *EFI_FILE_HANDLE;\r
 \r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SIMPLE_FILE_SYSTEM_PROTOCOL       EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL   EFI_FILE_IO_INTERFACE;\r
 typedef struct _EFI_FILE_PROTOCOL         EFI_FILE;\r
 \r
@@ -67,9 +67,9 @@ EFI_STATUS
 ;\r
 \r
 #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION  0x00010000\r
-//\r
-// Revision defined in EFI1.1\r
-// \r
+///\r
+/// Revision defined in EFI1.1\r
+/// \r
 #define EFI_FILE_IO_INTERFACE_REVISION  EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION\r
 \r
 struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL {\r
index 74c5163fbb9006940412d33a13e23f62e502c186..3766e98f972300f67aea464204782e41724b9856 100644 (file)
 typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL  EFI_SIMPLE_NETWORK_PROTOCOL;\r
 \r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_NETWORK_PROTOCOL   EFI_SIMPLE_NETWORK;\r
 \r
-//\r
-// Simple Network Protocol data structures\r
-//\r
+///\r
+/// Simple Network Protocol data structures\r
+///\r
 typedef struct {\r
-  //\r
-  // Total number of frames received.  Includes frames with errors and\r
-  // dropped frames.\r
-  //\r
+  ///\r
+  /// Total number of frames received.  Includes frames with errors and\r
+  /// dropped frames.\r
+  ///\r
   UINT64  RxTotalFrames;\r
 \r
-  //\r
-  // Number of valid frames received and copied into receive buffers.\r
-  //\r
+  ///\r
+  /// Number of valid frames received and copied into receive buffers.\r
+  ///\r
   UINT64  RxGoodFrames;\r
 \r
-  //\r
-  // Number of frames below the minimum length for the media.\r
-  // This would be <64 for ethernet.\r
-  //\r
+  ///\r
+  /// Number of frames below the minimum length for the media.\r
+  /// This would be <64 for ethernet.\r
+  ///\r
   UINT64  RxUndersizeFrames;\r
 \r
-  //\r
-  // Number of frames longer than the maxminum length for the\r
-  // media.  This would be >1500 for ethernet.\r
-  //\r
+  ///\r
+  /// Number of frames longer than the maxminum length for the\r
+  /// media.  This would be >1500 for ethernet.\r
+  ///\r
   UINT64  RxOversizeFrames;\r
 \r
-  //\r
-  // Valid frames that were dropped because receive buffers were full.\r
-  //\r
+  ///\r
+  /// Valid frames that were dropped because receive buffers were full.\r
+  ///\r
   UINT64  RxDroppedFrames;\r
 \r
-  //\r
-  // Number of valid unicast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid unicast frames received and not dropped.\r
+  ///\r
   UINT64  RxUnicastFrames;\r
 \r
-  //\r
-  // Number of valid broadcast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid broadcast frames received and not dropped.\r
+  ///\r
   UINT64  RxBroadcastFrames;\r
 \r
-  //\r
-  // Number of valid mutlicast frames received and not dropped.\r
-  //\r
+  ///\r
+  /// Number of valid mutlicast frames received and not dropped.\r
+  ///\r
   UINT64  RxMulticastFrames;\r
 \r
-  //\r
-  // Number of frames w/ CRC or alignment errors.\r
-  //\r
+  ///\r
+  /// Number of frames w/ CRC or alignment errors.\r
+  ///\r
   UINT64  RxCrcErrorFrames;\r
 \r
-  //\r
-  // Total number of bytes received.  Includes frames with errors\r
-  // and dropped frames.\r
+  ///\r
+  /// Total number of bytes received.  Includes frames with errors\r
+  /// and dropped frames.\r
   //\r
   UINT64  RxTotalBytes;\r
 \r
-  //\r
-  // Transmit statistics.\r
-  //\r
+  ///\r
+  /// Transmit statistics.\r
+  ///\r
   UINT64  TxTotalFrames;\r
   UINT64  TxGoodFrames;\r
   UINT64  TxUndersizeFrames;\r
@@ -107,14 +107,14 @@ typedef struct {
   UINT64  TxCrcErrorFrames;\r
   UINT64  TxTotalBytes;\r
 \r
-  //\r
-  // Number of collisions detection on this subnet.\r
-  //\r
+  ///\r
+  /// Number of collisions detection on this subnet.\r
+  ///\r
   UINT64  Collisions;\r
 \r
-  //\r
-  // Number of frames destined for unsupported protocol.\r
-  //\r
+  ///\r
+  /// Number of frames destined for unsupported protocol.\r
+  ///\r
   UINT64  UnsupportedProtocol;\r
 \r
 } EFI_NETWORK_STATISTICS;\r
index 292339a651ff30a3da1fded85fc397c1c93ce4e7..d7d58874e5e0f37d38dd5114dff076b86e0c1cf2 100644 (file)
     0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SIMPLE_INPUT_PROTOCOL   EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  EFI_SIMPLE_TEXT_INPUT_PROTOCOL;\r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
 typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL  SIMPLE_INPUT_INTERFACE;\r
 //\r
 // Data structures\r
index 5361e5c03d648c35e56dd14587650c1c3a032b64..6a00cfdb784773cf2ab321b86f40521f7e4d9ee8 100644 (file)
     0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \\r
   }\r
 \r
-//\r
-// Protocol GUID defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID defined in EFI1.1.\r
+/// \r
 #define SIMPLE_TEXT_OUTPUT_PROTOCOL   EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID\r
 \r
 typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL;\r
 \r
-//\r
-// Backward-compatible with EFI1.1.\r
-// \r
+///\r
+/// Backward-compatible with EFI1.1.\r
+/// \r
 typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   SIMPLE_TEXT_OUTPUT_INTERFACE;\r
 \r
 //\r
index 12d053d4becf2293345a9ecdd6e91c1ef651e8ed..cdf7b9bda9640989841d621f587d879ad5523cde 100644 (file)
 #ifndef __ARCH_PROTOCOL_TIMER_H__\r
 #define __ARCH_PROTOCOL_TIMER_H__\r
 \r
-//\r
-// Global ID for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Timer Architectural Protocol\r
+///\r
 #define EFI_TIMER_ARCH_PROTOCOL_GUID \\r
   { 0x26baccb3, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
 \r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
 typedef struct _EFI_TIMER_ARCH_PROTOCOL   EFI_TIMER_ARCH_PROTOCOL;\r
 \r
 /**\r
index 0954f545bdab40f6b5ac3f73060c1f66f54bc87f..4ca50d56f857d96a20272d8549de1b98cf028696 100644 (file)
 typedef struct _EFI_UNICODE_COLLATION_PROTOCOL  EFI_UNICODE_COLLATION_PROTOCOL;\r
 \r
 \r
-//\r
-// Protocol GUID name defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol GUID name defined in EFI1.1.\r
+/// \r
 #define UNICODE_COLLATION_PROTOCOL              EFI_UNICODE_COLLATION_PROTOCOL_GUID\r
 \r
-//\r
-// Protocol defined in EFI1.1.\r
-// \r
+///\r
+/// Protocol defined in EFI1.1.\r
+/// \r
 typedef EFI_UNICODE_COLLATION_PROTOCOL          UNICODE_COLLATION_INTERFACE;\r
 \r
-//\r
-// Protocol data structures and defines\r
-//\r
+///\r
+/// Protocol data structures and defines\r
+///\r
 #define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16) (0xfeff)\r
 \r
 //\r
index b494b3a156fb4c75c3e951c00ce66c7c46261bd9..54f67530dcfe8f1fdfa1a4d91e855179a95bb05d 100644 (file)
@@ -26,9 +26,9 @@
     0x3e745226, 0x9818, 0x45b6, {0xa2, 0xac, 0xd7, 0xcd, 0xe, 0x8b, 0xa2, 0xbc } \\r
   }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL;\r
 \r
 \r
index e42306a4ddccd88c02b771b4ac103623a8ab8c0c..6f9a0109b2f736e4131afb6138cbe935d3750656 100644 (file)
@@ -26,9 +26,9 @@
     0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \\r
   }\r
 \r
-//\r
-// Forward reference for pure ANSI compatability\r
-//\r
+///\r
+/// Forward reference for pure ANSI compatability\r
+///\r
 typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL;\r
 \r
 //\r
index ea60c20e6a3ab2438889291ccb55cf7765c2c220..9c09f1b49880e31cd97101f8805f229e580f5600 100644 (file)
@@ -23,9 +23,9 @@
 #ifndef __ARCH_PROTOCOL_VARIABLE_ARCH_H__\r
 #define __ARCH_PROTOCOL_VARIABLE_ARCH_H__\r
 \r
-//\r
-// Global ID for the Variable Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Variable Architectural Protocol\r
+///\r
 #define EFI_VARIABLE_ARCH_PROTOCOL_GUID \\r
   { 0x1e5668e2, 0x8481, 0x11d4, {0xbc, 0xf1, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } }\r
 \r
index cb8050eb0d942aaf8ace76a9c30b0540b52dec5f..802026b73930f5017b58b01d930b4f31865d0a73 100644 (file)
@@ -22,9 +22,9 @@
 #ifndef __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
 #define __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__\r
 \r
-//\r
-// Global ID for the Variable Write Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Variable Write Architectural Protocol\r
+///\r
 #define EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID \\r
   { 0x6441f818, 0x6362, 0x4e44, {0xb5, 0x70, 0x7d, 0xba, 0x31, 0xdd, 0x24, 0x53 } }\r
 \r
index d85dc5bb94dbc1297014da2aaa1cf41d53c87f79..3dc1a587ce304e6c9b452796af35f7f43250ebf2 100644 (file)
 #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 #define __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 \r
-//\r
-// Global ID for the Watchdog Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Watchdog Timer Architectural Protocol\r
+///\r
 #define EFI_WATCHDOG_TIMER_ARCH_PROTOCOL_GUID \\r
   { 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
 typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;\r
 \r
 /**\r