Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index 23a6f7d2d3becb6cfe778d4760a734147af918d1..1871489d3016270bda80ba8661ecf9c77b640122 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -3,7 +3,7 @@
   This file provides a definition of the EFI IPv4 Configuration\r
   Protocol.\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
@@ -61,12 +61,11 @@ typedef struct {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_CONFIG_START) (\r
+(EFIAPI *EFI_IP4_CONFIG_START)(\r
   IN EFI_IP4_CONFIG_PROTOCOL   *This,\r
   IN EFI_EVENT                 DoneEvent,\r
   IN EFI_EVENT                 ReconfigEvent\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Stops running the configuration policy for the EFI IPv4 Protocol driver.\r
@@ -80,10 +79,9 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_CONFIG_STOP) (\r
+(EFIAPI *EFI_IP4_CONFIG_STOP)(\r
   IN EFI_IP4_CONFIG_PROTOCOL   *This\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
   Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.\r
@@ -106,13 +104,16 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_IP4_CONFIG_GET_DATA) (\r
+(EFIAPI *EFI_IP4_CONFIG_GET_DATA)(\r
   IN EFI_IP4_CONFIG_PROTOCOL   *This,\r
   IN OUT UINTN                 *IpConfigDataSize,\r
   OUT EFI_IP4_IPCONFIG_DATA    *IpConfigData    OPTIONAL\r
-  )\r
-;\r
+  );\r
 \r
+///\r
+/// The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r
+/// configuration for the EFI IPv4 Protocol driver. \r
+///\r
 struct _EFI_IP4_CONFIG_PROTOCOL {\r
   EFI_IP4_CONFIG_START         Start;\r
   EFI_IP4_CONFIG_STOP          Stop;\r