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/Tcp4.h b/MdePkg/Include/Protocol/Tcp4.h
index 04b8c92..c1230f1 100644
--- a/MdePkg/Include/Protocol/Tcp4.h
+++ b/MdePkg/Include/Protocol/Tcp4.h
@@ -475,14 +475,13 @@ EFI_STATUS
   IN EFI_TCP4_PROTOCOL                   *This

   );

 

-/**  

-  @par Protocol Description:

-  The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by 

-  any network drivers or applications to send or receive data stream. 

-  It can either listen on a specified port as a service or actively connected 

-  to remote peer as a client. Each instance has its own independent settings, 

-  such as the routing table.

-**/

+///

+/// The EFI_TCP4_PROTOCOL defines the EFI TCPv4 Protocol child to be used by 

+/// any network drivers or applications to send or receive data stream. 

+/// It can either listen on a specified port as a service or actively connected 

+/// to remote peer as a client. Each instance has its own independent settings, 

+/// such as the routing table.

+///

 struct _EFI_TCP4_PROTOCOL {

   EFI_TCP4_GET_MODE_DATA                 GetModeData;

   EFI_TCP4_CONFIGURE                     Configure;