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, 8 insertions, 10 deletions

diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h
index 22a80e557a..84c40a01dc 100644
--- a/MdePkg/Include/Protocol/Usb2HostController.h
+++ b/MdePkg/Include/Protocol/Usb2HostController.h
@@ -553,16 +553,14 @@ EFI_STATUS
   IN EFI_USB_PORT_FEATURE    PortFeature

   );

 

-/**  

-  @par Protocol Description:

-  The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic 

-  data transactions over a USB bus, and USB root hub access. A device driver 

-  that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL 

-  instance that is associated with the USB bus to be managed. A device handle 

-  for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL 

-  instance, and an EFI_USB2_HC_PROTOCOL instance.

-

-**/

+///

+/// The EFI_USB2_HC_PROTOCOL provides USB host controller management, basic 

+/// data transactions over a USB bus, and USB root hub access. A device driver 

+/// that wishes to manage a USB bus in a system retrieves the EFI_USB2_HC_PROTOCOL 

+/// instance that is associated with the USB bus to be managed. A device handle 

+/// for a USB host controller will minimally contain an EFI_DEVICE_PATH_PROTOCOL 

+/// instance, and an EFI_USB2_HC_PROTOCOL instance.

+///

 struct _EFI_USB2_HC_PROTOCOL {

   EFI_USB2_HC_PROTOCOL_GET_CAPABILITY              GetCapability;

   EFI_USB2_HC_PROTOCOL_RESET                       Reset;