Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index e744ce42c9f3989672cb1fef10adf31cda382ff2..6dc9e615bc4006ed60ab3cea32a80ab15b1d1f45 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -1,5 +1,9 @@
 /** @file\r
-  Copyright (c) 2006, Intel Corporation\r
+\r
+  This file provides a definition of the EFI IPv4 Configuration\r
+  Protocol.\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
@@ -9,7 +13,6 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
-\r
 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__\r
 #define __EFI_IP4CONFIG_PROTOCOL_H__\r
 \r
@@ -58,7 +61,7 @@ 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
@@ -77,7 +80,7 @@ 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
@@ -103,13 +106,28 @@ 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
+  @par Protocol Description:\r
+  The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r
+  configuration for the EFI IPv4 Protocol driver. \r
+  \r
+  @param Start\r
+  Starts running the configuration policy for the EFI IPv4 Protocol driver. \r
+\r
+  @param Stop\r
+  Stops running the configuration policy for the EFI IPv4 Protocol driver. \r
+\r
+  @param GetData\r
+  Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.  \r
+\r
+**/\r
 struct _EFI_IP4_CONFIG_PROTOCOL {\r
   EFI_IP4_CONFIG_START         Start;\r
   EFI_IP4_CONFIG_STOP          Stop;\r