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 e72f57cf8f6c32c88fb1ca6cd865b94e87428cab..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
@@ -11,16 +11,17 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  DevicePathUtilities.h\r
-\r
 **/\r
 \r
 #ifndef __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
 #define __DEVICE_PATH_UTILITIES_PROTOCOL_H__\r
 \r
-//\r
-// Device Path Utilities protocol\r
-//\r
+\r
+#include <Protocol/DevicePath.h>\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
@@ -31,15 +32,14 @@
 \r
   @param  DevicePath Points to the start of the EFI device path.\r
 \r
-  @revtal Size       Size of the specified device path, in bytes, including the end-of-path tag.\r
+  @retval Size       Size of the specified device path, in bytes, including the end-of-path tag.\r
 \r
 **/\r
 typedef\r
 UINTN\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_GET_DEVICE_PATH_SIZE) (\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
@@ -53,10 +53,9 @@ UINTN
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_DUP_DEVICE_PATH) (\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
@@ -71,11 +70,10 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_PATH) (\r
+(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
@@ -90,11 +88,10 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_NODE) (\r
+(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
@@ -108,11 +105,10 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_APPEND_INSTANCE) (\r
+(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
@@ -131,11 +127,10 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_GET_NEXT_INSTANCE) (\r
+(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
@@ -154,12 +149,11 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_CREATE_NODE) (\r
+(EFIAPI *EFI_DEVICE_PATH_CREATE_NODE)(\r
   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
@@ -172,12 +166,13 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 BOOLEAN\r
-(EFIAPI *EFI_DEVICE_PATH_UTILS_IS_MULTI_INSTANCE) (\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