modify coding style to pass ecc tool and provide comments that complied with Doxgen.

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

diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c
index bf40656ae9d54f6935b917dfba336160cfc8f075..aeab8f11aa15f723dfa5a9812c87a6a64a4afe2c 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/Hid.c
+++ b/MdePkg/Library/UefiUsbLib/Hid.c
@@ -17,10 +17,10 @@
 \r
 \r
 /**\r
-  Get Hid Descriptor\r
+  Get Hid Descriptor.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
-  @param  InterfaceNum      Hid interface number\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
+  @param  InterfaceNum      Hid interface number.\r
   @param  HidDescriptor     Caller allocated buffer to store Usb hid descriptor if\r
                             successfully returned.\r
 \r
@@ -63,12 +63,9 @@ UsbGetHidDescriptor (
   return Result;\r
 \r
 }\r
-//\r
-// Function to get Report Class descriptor\r
-//\r
 \r
 /**\r
-  get Report Class descriptor\r
+  Get Report Class descriptor.\r
 \r
   @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
   @param  InterfaceNum      Report interface number.\r
@@ -118,15 +115,12 @@ UsbGetReportDescriptor (
   return Result;\r
 \r
 }\r
-//\r
-// Following are HID class request\r
-//\r
 \r
 /**\r
-  Get Hid Protocol Request\r
+  Get Hid Protocol Request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
-  @param  Interface         Which interface the caller wants to get protocol\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
+  @param  Interface         Which interface the caller wants to get protocol.\r
   @param  Protocol          Protocol value returned.\r
 \r
   @return EFI_SUCCESS\r
@@ -174,12 +168,11 @@ UsbGetProtocolRequest (
 }\r
 \r
 \r
-\r
 /**\r
-  Set Hid Protocol Request\r
+  Set Hid Protocol Request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
-  @param  Interface         Which interface the caller wants to set protocol\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
+  @param  Interface         Which interface the caller wants to set protocol.\r
   @param  Protocol          Protocol value the caller wants to set.\r
 \r
   @return EFI_SUCCESS\r
@@ -226,11 +219,10 @@ UsbSetProtocolRequest (
 }\r
 \r
 \r
-\r
 /**\r
   Set Idel request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
   @param  Interface         Which interface the caller wants to set.\r
   @param  ReportId          Which report the caller wants to set.\r
   @param  Duration          Idle rate the caller wants to set.\r
@@ -283,7 +275,7 @@ UsbSetIdleRequest (
 /**\r
   Get Idel request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
   @param  Interface         Which interface the caller wants to get.\r
   @param  ReportId          Which report the caller wants to get.\r
   @param  Duration          Idle rate the caller wants to get.\r
@@ -334,11 +326,10 @@ UsbGetIdleRequest (
 }\r
 \r
 \r
-\r
 /**\r
   Hid Set Report request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
   @param  Interface         Which interface the caller wants to set.\r
   @param  ReportId          Which report the caller wants to set.\r
   @param  ReportType        Type of report.\r
@@ -396,7 +387,7 @@ UsbSetReportRequest (
 /**\r
   Hid Set Report request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
   @param  Interface         Which interface the caller wants to set.\r
   @param  ReportId          Which report the caller wants to set.\r
   @param  ReportType        Type of report.\r

diff --git a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
index 9d7be04d21c5bcd7294d78565789b4b90bd7efbf..8bfd8c9b49522073c1921ff66068f143377b1a76 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
+++ b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
@@ -1,4 +1,5 @@
-/**@file\r
+/** @file\r
+  \r
   Common header file shared by all source files.\r
 \r
   This file includes package header files, library classes and protocol, PPI & GUID definitions.\r

diff --git a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
index a3ac0e614016ecff0da5c5ba3c8201c3fe77b8a7..3e764a34a68867f5af3032b734ce73fe680dbe50 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
+++ b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
@@ -20,18 +20,18 @@
 \r
 \r
 /**\r
-  Usb Get Descriptor\r
+  Usb Get Descriptor.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Value                  Device Request Value\r
-  @param  Index                  Device Request Index\r
-  @param  DescriptorLength       Descriptor Length\r
-  @param  Descriptor             Descriptor buffer to contain result\r
-  @param  Status                 Transfer Status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Value                  Device Request Value.\r
+  @param  Index                  Device Request Index.\r
+  @param  DescriptorLength       Descriptor Length.\r
+  @param  Descriptor             Descriptor buffer to contain result.\r
+  @param  Status                 Transfer Status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -72,18 +72,18 @@ UsbGetDescriptor (
 \r
 \r
 /**\r
-  Usb Set Descriptor\r
+  Usb Set Descriptor.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Value                  Device Request Value\r
-  @param  Index                  Device Request Index\r
-  @param  DescriptorLength       Descriptor Length\r
-  @param  Descriptor             Descriptor buffer to set\r
-  @param  Status                 Transfer Status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Value                  Device Request Value.\r
+  @param  Index                  Device Request Index.\r
+  @param  DescriptorLength       Descriptor Length.\r
+  @param  Descriptor             Descriptor buffer to set.\r
+  @param  Status                 Transfer Status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -124,16 +124,16 @@ UsbSetDescriptor (
 \r
 \r
 /**\r
-  Usb Get Device Interface\r
+  Usb Get Device Interface.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Index                  Interface index value\r
-  @param  AltSetting             Alternate setting\r
-  @param  Status                 Trasnsfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Index                  Interface index value.\r
+  @param  AltSetting             Alternate setting.\r
+  @param  Status                 Trasnsfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -171,16 +171,16 @@ UsbGetInterface (
 \r
 \r
 /**\r
-  Usb Set Device Interface\r
+  Usb Set Device Interface.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  InterfaceNo            Interface Number\r
-  @param  AltSetting             Alternate setting\r
-  @param  Status                 Trasnsfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  InterfaceNo            Interface Number.\r
+  @param  AltSetting             Alternate setting.\r
+  @param  Status                 Trasnsfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -219,15 +219,15 @@ UsbSetInterface (
 \r
 \r
 /**\r
-  Usb Get Device Configuration\r
+  Usb Get Device Configuration.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  ConfigValue            Config Value\r
-  @param  Status                 Transfer Status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  ConfigValue            Config Value.\r
+  @param  Status                 Transfer Status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -263,15 +263,15 @@ UsbGetConfiguration (
 \r
 \r
 /**\r
-  Usb Set Device Configuration\r
+  Usb Set Device Configuration.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Value                  Configuration Value to set\r
-  @param  Status                 Transfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Value                  Configuration Value to set.\r
+  @param  Status                 Transfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -307,17 +307,17 @@ UsbSetConfiguration (
 \r
 \r
 /**\r
-  Usb Set Device Feature\r
+  Usb Set Device Feature.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Recipient              Interface/Device/Endpoint\r
-  @param  Value                  Request value\r
-  @param  Target                 Request Index\r
-  @param  Status                 Transfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Recipient              Interface/Device/Endpoint.\r
+  @param  Value                  Request value.\r
+  @param  Target                 Request Index.\r
+  @param  Status                 Transfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -373,17 +373,17 @@ UsbSetFeature (
 \r
 \r
 /**\r
-  Usb Clear Device Feature\r
+  Usb Clear Device Feature.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Recipient              Interface/Device/Endpoint\r
-  @param  Value                  Request value\r
-  @param  Target                 Request Index\r
-  @param  Status                 Transfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Recipient              Interface/Device/Endpoint.\r
+  @param  Value                  Request value.\r
+  @param  Target                 Request Index.\r
+  @param  Status                 Transfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -439,17 +439,17 @@ UsbClearFeature (
 \r
 \r
 /**\r
-  Usb Get Device Status\r
+  Usb Get Device Status.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  Recipient              Interface/Device/Endpoint\r
-  @param  Target                 Request index\r
-  @param  DevStatus              Device status\r
-  @param  Status                 Transfer status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  Recipient              Interface/Device/Endpoint.\r
+  @param  Target                 Request index.\r
+  @param  DevStatus              Device status.\r
+  @param  Status                 Transfer status.\r
 \r
-  @retval EFI_INVALID_PARAMETER  Parameter is error\r
-  @retval EFI_SUCCESS            Success\r
-  @retval EFI_TIMEOUT            Device has no response\r
+  @retval EFI_INVALID_PARAMETER  Parameter is error.\r
+  @retval EFI_SUCCESS            Success.\r
+  @retval EFI_TIMEOUT            Device has no response.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -504,17 +504,16 @@ UsbGetStatus (
 }\r
 \r
 \r
-\r
 /**\r
-  Clear endpoint stall\r
+  Clear endpoint stall.\r
 \r
-  @param  UsbIo                  EFI_USB_IO_PROTOCOL\r
-  @param  EndpointNo             Endpoint Number\r
-  @param  Status                 Transfer Status\r
+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.\r
+  @param  EndpointNo             Endpoint Number.\r
+  @param  Status                 Transfer Status.\r
 \r
-  @retval EFI_NOT_FOUND          Can't find the Endpoint\r
-  @retval EFI_DEVICE_ERROR       Hardware error\r
-  @retval EFI_SUCCESS            Success\r
+  @retval EFI_NOT_FOUND          Can't find the Endpoint.\r
+  @retval EFI_DEVICE_ERROR       Hardware error.\r
+  @retval EFI_SUCCESS            Success.\r
 \r
 **/\r
 EFI_STATUS\r