Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/DevicePathFromText.h b/MdePkg/Include/Protocol/DevicePathFromText.h
index a3a6c431ca88668f4b14f930de48a23c15204e3f..5caf5dff056c7afa49a526cd40e4d23a0ce851f6 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,13 +11,13 @@
   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
 #define __DEVICE_PATH_FROM_TEXT_PROTOCOL_H__\r
 \r
+#include <Protocol/DevicePath.h>\r
+\r
 //\r
 // Device Path From Text protocol\r
 //\r
@@ -39,7 +39,7 @@
 **/\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
@@ -58,14 +58,25 @@ 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
+  @par Protocol Description:\r
+  This protocol converts text to device paths and device nodes.\r
+\r
+  @param ConvertTextToDeviceNode\r
+  Convert text to a device node.\r
+  \r
+  @param ConvertTextToDevicePath\r
+  Convert text to a device path\r
   \r
+**/   \r
 typedef struct {\r
-  EFI_DEVICE_PATH_FROM_TEXT_NODE  ConvertDeviceNodeFromText;\r
-  EFI_DEVICE_PATH_FROM_TEXT_PATH  ConvertDevicePathFromText;\r
+  EFI_DEVICE_PATH_FROM_TEXT_NODE  ConvertTextToDeviceNode;\r
+  EFI_DEVICE_PATH_FROM_TEXT_PATH  ConvertTextToDevicePath;\r
 } EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL;\r
 \r
 extern EFI_GUID gEfiDevicePathFromTextProtocolGuid;\r