Update comments for Protocol definitions to match UEFI spec.

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

diff --git a/MdePkg/Include/Protocol/DebugPort.h b/MdePkg/Include/Protocol/DebugPort.h
index ceffaf695489b79c950a97d6fa0ef0a17306e1b8..13c7db94fa8ae6e68b9f5457bda05b7da6b62624 100644 (file)
--- a/MdePkg/Include/Protocol/DebugPort.h
+++ b/MdePkg/Include/Protocol/DebugPort.h
@@ -1,5 +1,10 @@
 /** @file\r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  \r
+  The file defines the EFI Debugport protocol.\r
+  This protocol is used by debug agent to communicate with the\r
+  remote debug host.\r
+  \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
@@ -8,17 +13,15 @@
   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:  DebugPort.h\r
-\r
 **/\r
 \r
 #ifndef __DEBUG_PORT_H__\r
 #define __DEBUG_PORT_H__\r
 \r
 \r
-//\r
-// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}\r
-//\r
+///\r
+/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0}\r
+///\r
 #define EFI_DEBUGPORT_PROTOCOL_GUID \\r
   { \\r
     0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \\r
@@ -43,7 +46,7 @@ typedef struct _EFI_DEBUGPORT_PROTOCOL EFI_DEBUGPORT_PROTOCOL;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DEBUGPORT_RESET) (\r
+(EFIAPI *EFI_DEBUGPORT_RESET)(\r
   IN EFI_DEBUGPORT_PROTOCOL               *This\r
   );\r
 \r
@@ -63,7 +66,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DEBUGPORT_WRITE) (\r
+(EFIAPI *EFI_DEBUGPORT_WRITE)(\r
   IN EFI_DEBUGPORT_PROTOCOL               *This,\r
   IN UINT32                               Timeout,\r
   IN OUT UINTN                            *BufferSize,\r
@@ -87,7 +90,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DEBUGPORT_READ) (\r
+(EFIAPI *EFI_DEBUGPORT_READ)(\r
   IN EFI_DEBUGPORT_PROTOCOL               *This,\r
   IN UINT32                               Timeout,\r
   IN OUT UINTN                            *BufferSize,\r
@@ -106,13 +109,13 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_DEBUGPORT_POLL) (\r
+(EFIAPI *EFI_DEBUGPORT_POLL)(\r
   IN EFI_DEBUGPORT_PROTOCOL               *This\r
   );\r
 \r
-//\r
-// DebugPort protocol definition\r
-//\r
+///\r
+/// This protocol provides the communication link between the debug agent and the remote host.\r
+///\r
 struct _EFI_DEBUGPORT_PROTOCOL {\r
   EFI_DEBUGPORT_RESET Reset;\r
   EFI_DEBUGPORT_WRITE Write;\r