Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Uefi / UefiMultiPhase.h

diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h
index d427296406a3bb40bc58fed5a4b65205e83aee4a..0cbf2a6a63c7e7fabddbcfd92a4b7be4bd4c92aa 100644 (file)
--- a/MdePkg/Include/Uefi/UefiMultiPhase.h
+++ b/MdePkg/Include/Uefi/UefiMultiPhase.h
@@ -15,9 +15,11 @@
 #ifndef __UEFI_MULTIPHASE_H__\r
 #define __UEFI_MULTIPHASE_H__\r
 \r
-//\r
-// Enumeration of memory types introduced in UEFI.\r
-// \r
+#include <ProcessorBind.h>\r
+\r
+///\r
+/// Enumeration of memory types introduced in UEFI.\r
+/// \r
 typedef enum {\r
   EfiReservedMemoryType,\r
   EfiLoaderCode,\r
@@ -37,9 +39,9 @@ typedef enum {
 } EFI_MEMORY_TYPE;\r
 \r
 \r
-//\r
-// Data structure that precedes all of the standard EFI table types.\r
-// \r
+///\r
+/// Data structure that precedes all of the standard EFI table types.\r
+/// \r
 typedef struct {\r
   UINT64  Signature;\r
   UINT32  Revision;\r
@@ -48,22 +50,20 @@ typedef struct {
   UINT32  Reserved;\r
 } EFI_TABLE_HEADER;\r
 \r
-//\r
-// Attributes of variable.\r
-// \r
+///\r
+/// Attributes of variable.\r
+/// \r
 #define EFI_VARIABLE_NON_VOLATILE                 0x00000001\r
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS           0x00000002\r
 #define EFI_VARIABLE_RUNTIME_ACCESS               0x00000004\r
 #define EFI_VARIABLE_HARDWARE_ERROR_RECORD        0x00000008\r
 \r
-//\r
-// This attribute is identified by the mnemonic 'HR' \r
-// elsewhere in this specification.\r
-// \r
+///\r
+/// This attribute is identified by the mnemonic 'HR' \r
+/// elsewhere in this specification.\r
+/// \r
 #define EFI_VARIABLE_AUTHENTICATED_WRITE_ACCESS   0x00000010\r
 \r
-\r
-\r
 //\r
 // _WIN_CERTIFICATE.wCertificateType\r
 // \r
@@ -135,16 +135,6 @@ typedef struct _EFI_CERT_BLOCK_RSA_2048_SHA256 {
                     this case the value is\r
                     EFI_CERT_BLOCK_RSA_2048_SHA256.\r
 \r
-  @param Information  The WIN_CERTIFICATE_UEFI_GUID certificate\r
-                      type allows new types of certificates to\r
-                      be developed for driver authentication\r
-                      without requiring a new certificate type.\r
-                      The CertType defines the format of the\r
-                      CertData, which length is defined by the\r
-                      size of the certificate less the fixed\r
-                      size of the WIN_CERTIFICATE_UEFI_GUID\r
-                      structure.\r
-\r
 **/\r
 typedef struct _WIN_CERTIFICATE_UEFI_GUID {\r
   WIN_CERTIFICATE   Hdr;\r
@@ -153,10 +143,6 @@ typedef struct _WIN_CERTIFICATE_UEFI_GUID {
 } WIN_CERTIFICATE_UEFI_GUID;\r
 \r
 \r
-\r
-\r
-\r
-\r
 /**\r
    \r
   Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital\r