Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/DevicePathUtilities.h b/MdePkg/Include/Protocol/DevicePathUtilities.h
index 3874d63491dbf8a120ce16f6689ed454714ac460..cf247d24ba31b6ee4641cd8d341487db3bfc0b5e 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePathUtilities.h
+++ b/MdePkg/Include/Protocol/DevicePathUtilities.h
@@ -2,7 +2,7 @@
   EFI_DEVICE_PATH_UTILITIES_PROTOCOL as defined in UEFI 2.0.  \r
   Use to create and manipulate device paths and device nodes.\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -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
@@ -39,8 +39,7 @@ typedef
 UINTN\r
 (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
-  )\r
-;    \r
+  );    \r
   \r
 \r
 /**\r
@@ -56,8 +55,7 @@ typedef
 EFI_DEVICE_PATH_PROTOCOL*\r
 (EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Create a new path by appending the second device path to the first.\r
@@ -75,8 +73,7 @@ EFI_DEVICE_PATH_PROTOCOL*
 (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *Src1,\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *Src2\r
-  )\r
-;     \r
+  );     \r
   \r
 /**\r
   Creates a new path by appending the device node to the device path.\r
@@ -94,8 +91,7 @@ EFI_DEVICE_PATH_PROTOCOL*
 (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_NODE)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DeviceNode\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Creates a new path by appending the specified device path instance to the specified device path.\r
@@ -112,8 +108,7 @@ EFI_DEVICE_PATH_PROTOCOL*
 (EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL *DevicePathInstance\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Creates a copy of the current device path instance and returns a pointer to the next device path\r
@@ -135,8 +130,7 @@ EFI_DEVICE_PATH_PROTOCOL*
 (EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE)(\r
   IN  OUT EFI_DEVICE_PATH_PROTOCOL  **DevicePathInstance,\r
   OUT UINTN                         *DevicePathInstanceSize\r
-  )\r
-;  \r
+  );  \r
 \r
 /**\r
   Creates a device node\r
@@ -159,8 +153,7 @@ EFI_DEVICE_PATH_PROTOCOL*
   IN UINT8                          NodeType,\r
   IN UINT8                          NodeSubType,\r
   IN UINT16                         NodeLength\r
-)\r
-;   \r
+);   \r
 \r
 /**\r
   Returns whether a device path is multi-instance.\r
@@ -175,10 +168,11 @@ typedef
 BOOLEAN\r
 (EFIAPI *EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE)(\r
   IN CONST EFI_DEVICE_PATH_PROTOCOL         *DevicePath\r
-  )\r
-;                                                                                                       \r
+  );                                                                                                       \r
   \r
-\r
+///\r
+/// This protocol is used to creates and manipulates device paths and device nodes.\r
+/// \r
 typedef struct {\r
   EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE GetDevicePathSize;\r
   EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH      DuplicateDevicePath;\r