Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/DevicePathToText.h b/MdePkg/Include/Protocol/DevicePathToText.h
index 0946794c38b1fa50e6f6a8ef37d9e1c93927b629..4767e08c930d86a8c8a7fbf9508a4c91d6d3ba9c 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePathToText.h
+++ b/MdePkg/Include/Protocol/DevicePathToText.h
@@ -2,7 +2,7 @@
   EFI_DEVICE_PATH_TO_TEXT_PROTOCOL as defined in UEFI 2.0.  \r
   This protocol provides service to convert device nodes and paths to text.\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
@@ -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
@@ -47,8 +47,7 @@ CHAR16*
   IN CONST EFI_DEVICE_PATH_PROTOCOL   *DeviceNode,\r
   IN BOOLEAN                          DisplayOnly,\r
   IN BOOLEAN                          AllowShortcuts\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Convert a device path to its text representation.\r
@@ -71,9 +70,11 @@ CHAR16*
   IN CONST EFI_DEVICE_PATH_PROTOCOL   *DevicePath,\r
   IN BOOLEAN                          DisplayOnly,\r
   IN BOOLEAN                          AllowShortcuts\r
-  )\r
-;    \r
+  );    \r
 \r
+///\r
+/// This protocol converts device paths and device nodes to text.\r
+///\r
 typedef struct {\r
   EFI_DEVICE_PATH_TO_TEXT_NODE        ConvertDeviceNodeToText;\r
   EFI_DEVICE_PATH_TO_TEXT_PATH        ConvertDevicePathToText;\r