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, 9 deletions

diff --git a/MdePkg/Include/Protocol/UsbHostController.h b/MdePkg/Include/Protocol/UsbHostController.h
index 89de708e88..803316f145 100644
--- a/MdePkg/Include/Protocol/UsbHostController.h
+++ b/MdePkg/Include/Protocol/UsbHostController.h
@@ -468,15 +468,13 @@ EFI_STATUS
   );

 

 

-/**  

-  @par Protocol Description:

-  The EFI_USB_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_USB_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_USB_HC_PROTOCOL instance. 

-

-**/

+///

+/// The EFI_USB_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_USB_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_USB_HC_PROTOCOL instance. 

+///

 struct _EFI_USB_HC_PROTOCOL {

   EFI_USB_HC_PROTOCOL_RESET                       Reset;

   EFI_USB_HC_PROTOCOL_GET_STATE                   GetState;