Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/DevicePathFromText.h b/MdePkg/Include/Protocol/DevicePathFromText.h
index 31b2e068db00a75ebd1cb979c42d3cd71d35aa35..ffac71597802caf6c1c9048326573e6d72737530 100644 (file)
--- a/MdePkg/Include/Protocol/DevicePathFromText.h
+++ b/MdePkg/Include/Protocol/DevicePathFromText.h
@@ -2,7 +2,7 @@
   EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL as defined in UEFI 2.0.  \r
   This protocol provides service to convert text to 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,8 +11,6 @@
   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:  DevicePathFromText.h\r
-\r
 **/\r
 \r
 #ifndef __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
@@ -20,9 +18,9 @@
 \r
 #include <Protocol/DevicePath.h>\r
 \r
-//\r
-// Device Path From Text protocol\r
-//\r
+///\r
+/// Device Path From Text protocol\r
+///\r
 #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \\r
   { \\r
     0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e  } \\r
@@ -41,10 +39,9 @@
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE) (\r
+(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_NODE)(\r
   IN CONST CHAR16                 *TextDeviceNode\r
-  )\r
-;    \r
+  );    \r
   \r
 \r
 /**\r
@@ -60,11 +57,13 @@ EFI_DEVICE_PATH_PROTOCOL*
 **/\r
 typedef\r
 EFI_DEVICE_PATH_PROTOCOL*\r
-(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH) (\r
+(EFIAPI *EFI_DEVICE_PATH_FROM_TEXT_PATH)(\r
   IN CONST CHAR16                 *TextDevicePath\r
-  )\r
-;  \r
-  \r
+  );  \r
+\r
+///\r
+/// This protocol converts text to device paths and device nodes.\r
+///\r
 typedef struct {\r
   EFI_DEVICE_PATH_FROM_TEXT_NODE  ConvertTextToDeviceNode;\r
   EFI_DEVICE_PATH_FROM_TEXT_PATH  ConvertTextToDevicePath;\r