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

[mirror_edk2.git] / MdePkg / Include / Protocol / DevicePath.h

diff --git a/MdePkg/Include/Protocol/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h
index fddf972bef8bdc399c9776089934f5c964c145c1..48c8f4b77bb05c42ca245c393f6b418e2ff015ea 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePath.h
+++ b/MdePkg/Include/Protocol/DevicePath.h
@@ -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