Formalize comments for Protocols and PPIs.

1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.

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

1 files changed, 7 insertions, 8 deletions

diff --git a/MdePkg/Include/Protocol/Udp4.h b/MdePkg/Include/Protocol/Udp4.h
index 86e1c30..b7409f2 100644
--- a/MdePkg/Include/Protocol/Udp4.h
+++ b/MdePkg/Include/Protocol/Udp4.h
@@ -342,14 +342,13 @@ EFI_STATUS
   IN EFI_UDP4_COMPLETION_TOKEN  *Token  OPTIONAL

   );       

 

-/**  

-  @par Protocol Description:

-  The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used 

-  by any network drivers, applications, or daemons to transmit or receive UDP packets. 

-  This protocol instance can either be bound to a specified port as a service or 

-  connected to some remote peer as an active client. Each instance has its own settings, 

-  such as the routing table and group table, which are independent from each other.

-**/

+///

+/// The EFI_UDP4_PROTOCOL defines an EFI UDPv4 Protocol session that can be used 

+/// by any network drivers, applications, or daemons to transmit or receive UDP packets. 

+/// This protocol instance can either be bound to a specified port as a service or 

+/// connected to some remote peer as an active client. Each instance has its own settings, 

+/// such as the routing table and group table, which are independent from each other.

+///

 struct _EFI_UDP4_PROTOCOL {

   EFI_UDP4_GET_MODE_DATA        GetModeData;

   EFI_UDP4_CONFIGURE            Configure;