[Description]

  Scrub MdePkg:
  - Add file description with doxygen format.
  - Add calling convention of library class in MdePkg.
  - Add function descriptions of public protocol/library class.

[Impaction]
  It should be backward-compatible.

[Ref Info]
  N/A
 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@4985 6f19259b-4bc3-4df7-8a09-765794883524

5 files changed, 37 insertions, 1 deletions

diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h
index c9000c7062..662fd9de25 100644
--- a/MdePkg/Include/Protocol/Arp.h
+++ b/MdePkg/Include/Protocol/Arp.h
@@ -1,4 +1,15 @@
 /** @file

+  

+  EFI ARP Protocol Definition

+  

+  The EFI ARP Service Binding Protocol is used to locate EFI

+  ARP Protocol drivers to create and destroy child of the

+  driver to communicate with other host using ARP protocol.

+  

+  The EFI ARP Protocol provides services to map IP network

+  address to hardware address used by a data link protocol.

+  

+  

   Copyright (c) 2006, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

diff --git a/MdePkg/Include/Protocol/DebugPort.h b/MdePkg/Include/Protocol/DebugPort.h
index d560554ce9..afe656ded5 100644
--- a/MdePkg/Include/Protocol/DebugPort.h
+++ b/MdePkg/Include/Protocol/DebugPort.h
@@ -1,4 +1,9 @@
 /** @file

+  

+  The file defines the EFI Debugport protocol.

+  This protocol is used by debug agent to communicate with the

+  remote debug host.

+  

   Copyright (c) 2006, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h
index 9988549645..a72244e2c8 100644
--- a/MdePkg/Include/Protocol/Ip4.h
+++ b/MdePkg/Include/Protocol/Ip4.h
@@ -1,4 +1,16 @@
 /** @file

+  

+  This file defines the EFI IPv4 (Internet Protocol version 4)

+  Protocol interface. It is split into the following three main

+  sections:

+  - EFI IPv4 Service Binding Protocol

+  - EFI IPv4 Variable

+  - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic

+    network IPv4 packet I/O services, which includes support for

+    a subset of the Internet Control Message Protocol (ICMP) and

+    may include support for the Internet Group Management

+    Protocol (IGMP).

+  

   Copyright (c) 2006, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License         

diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index e744ce42c9..23a6f7d2d3 100644
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -1,4 +1,8 @@
 /** @file

+

+  This file provides a definition of the EFI IPv4 Configuration

+  Protocol.

+

   Copyright (c) 2006, Intel Corporation

   All rights reserved. This program and the accompanying materials

   are licensed and made available under the terms and conditions of the BSD License

@@ -9,7 +13,6 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

 **/

-

 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__

 #define __EFI_IP4CONFIG_PROTOCOL_H__

 

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index 2fd0805f46..42cd9978c4 100644
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -1,4 +1,9 @@
 /** @file

+

+  The file defines the generic Service Binding Protocol

+  functions.

+

+

   Copyright (c) 2006, Intel Corporation                                                         

   All rights reserved. This program and the accompanying materials                          

   are licensed and made available under the terms and conditions of the BSD License