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

3 files changed, 100 insertions, 109 deletions

diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c
index bf40656ae9..aeab8f11aa 100644
--- a/MdePkg/Library/UefiUsbLib/Hid.c
+++ b/MdePkg/Library/UefiUsbLib/Hid.c
@@ -17,10 +17,10 @@
 

 

 /**

-  Get Hid Descriptor

+  Get Hid Descriptor.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

-  @param  InterfaceNum      Hid interface number

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

+  @param  InterfaceNum      Hid interface number.

   @param  HidDescriptor     Caller allocated buffer to store Usb hid descriptor if

                             successfully returned.

 

@@ -63,12 +63,9 @@ UsbGetHidDescriptor (
   return Result;

 

 }

-//

-// Function to get Report Class descriptor

-//

 

 /**

-  get Report Class descriptor

+  Get Report Class descriptor.

 

   @param  UsbIo             EFI_USB_IO_PROTOCOL.

   @param  InterfaceNum      Report interface number.

@@ -118,15 +115,12 @@ UsbGetReportDescriptor (
   return Result;

 

 }

-//

-// Following are HID class request

-//

 

 /**

-  Get Hid Protocol Request

+  Get Hid Protocol Request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

-  @param  Interface         Which interface the caller wants to get protocol

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

+  @param  Interface         Which interface the caller wants to get protocol.

   @param  Protocol          Protocol value returned.

 

   @return EFI_SUCCESS

@@ -174,12 +168,11 @@ UsbGetProtocolRequest (
 }

 

 

-

 /**

-  Set Hid Protocol Request

+  Set Hid Protocol Request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

-  @param  Interface         Which interface the caller wants to set protocol

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

+  @param  Interface         Which interface the caller wants to set protocol.

   @param  Protocol          Protocol value the caller wants to set.

 

   @return EFI_SUCCESS

@@ -226,11 +219,10 @@ UsbSetProtocolRequest (
 }

 

 

-

 /**

   Set Idel request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

   @param  Interface         Which interface the caller wants to set.

   @param  ReportId          Which report the caller wants to set.

   @param  Duration          Idle rate the caller wants to set.

@@ -283,7 +275,7 @@ UsbSetIdleRequest (
 /**

   Get Idel request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

   @param  Interface         Which interface the caller wants to get.

   @param  ReportId          Which report the caller wants to get.

   @param  Duration          Idle rate the caller wants to get.

@@ -334,11 +326,10 @@ UsbGetIdleRequest (
 }

 

 

-

 /**

   Hid Set Report request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

   @param  Interface         Which interface the caller wants to set.

   @param  ReportId          Which report the caller wants to set.

   @param  ReportType        Type of report.

@@ -396,7 +387,7 @@ UsbSetReportRequest (
 /**

   Hid Set Report request.

 

-  @param  UsbIo             EFI_USB_IO_PROTOCOL

+  @param  UsbIo             EFI_USB_IO_PROTOCOL.

   @param  Interface         Which interface the caller wants to set.

   @param  ReportId          Which report the caller wants to set.

   @param  ReportType        Type of report.

diff --git a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
index 9d7be04d21..8bfd8c9b49 100644
--- a/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
+++ b/MdePkg/Library/UefiUsbLib/UefiUsbLibInternal.h
@@ -1,4 +1,5 @@
-/**@file

+/** @file

+  

   Common header file shared by all source files.

 

   This file includes package header files, library classes and protocol, PPI & GUID definitions.

diff --git a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
index a3ac0e6140..3e764a34a6 100644
--- a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
+++ b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
@@ -20,18 +20,18 @@
 

 

 /**

-  Usb Get Descriptor

+  Usb Get Descriptor.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Value                  Device Request Value

-  @param  Index                  Device Request Index

-  @param  DescriptorLength       Descriptor Length

-  @param  Descriptor             Descriptor buffer to contain result

-  @param  Status                 Transfer Status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Value                  Device Request Value.

+  @param  Index                  Device Request Index.

+  @param  DescriptorLength       Descriptor Length.

+  @param  Descriptor             Descriptor buffer to contain result.

+  @param  Status                 Transfer Status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -72,18 +72,18 @@ UsbGetDescriptor (
 

 

 /**

-  Usb Set Descriptor

+  Usb Set Descriptor.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Value                  Device Request Value

-  @param  Index                  Device Request Index

-  @param  DescriptorLength       Descriptor Length

-  @param  Descriptor             Descriptor buffer to set

-  @param  Status                 Transfer Status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Value                  Device Request Value.

+  @param  Index                  Device Request Index.

+  @param  DescriptorLength       Descriptor Length.

+  @param  Descriptor             Descriptor buffer to set.

+  @param  Status                 Transfer Status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -124,16 +124,16 @@ UsbSetDescriptor (
 

 

 /**

-  Usb Get Device Interface

+  Usb Get Device Interface.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Index                  Interface index value

-  @param  AltSetting             Alternate setting

-  @param  Status                 Trasnsfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Index                  Interface index value.

+  @param  AltSetting             Alternate setting.

+  @param  Status                 Trasnsfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -171,16 +171,16 @@ UsbGetInterface (
 

 

 /**

-  Usb Set Device Interface

+  Usb Set Device Interface.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  InterfaceNo            Interface Number

-  @param  AltSetting             Alternate setting

-  @param  Status                 Trasnsfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  InterfaceNo            Interface Number.

+  @param  AltSetting             Alternate setting.

+  @param  Status                 Trasnsfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -219,15 +219,15 @@ UsbSetInterface (
 

 

 /**

-  Usb Get Device Configuration

+  Usb Get Device Configuration.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  ConfigValue            Config Value

-  @param  Status                 Transfer Status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  ConfigValue            Config Value.

+  @param  Status                 Transfer Status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -263,15 +263,15 @@ UsbGetConfiguration (
 

 

 /**

-  Usb Set Device Configuration

+  Usb Set Device Configuration.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Value                  Configuration Value to set

-  @param  Status                 Transfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Value                  Configuration Value to set.

+  @param  Status                 Transfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -307,17 +307,17 @@ UsbSetConfiguration (
 

 

 /**

-  Usb Set Device Feature

+  Usb Set Device Feature.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Recipient              Interface/Device/Endpoint

-  @param  Value                  Request value

-  @param  Target                 Request Index

-  @param  Status                 Transfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Recipient              Interface/Device/Endpoint.

+  @param  Value                  Request value.

+  @param  Target                 Request Index.

+  @param  Status                 Transfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -373,17 +373,17 @@ UsbSetFeature (
 

 

 /**

-  Usb Clear Device Feature

+  Usb Clear Device Feature.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Recipient              Interface/Device/Endpoint

-  @param  Value                  Request value

-  @param  Target                 Request Index

-  @param  Status                 Transfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Recipient              Interface/Device/Endpoint.

+  @param  Value                  Request value.

+  @param  Target                 Request Index.

+  @param  Status                 Transfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -439,17 +439,17 @@ UsbClearFeature (
 

 

 /**

-  Usb Get Device Status

+  Usb Get Device Status.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  Recipient              Interface/Device/Endpoint

-  @param  Target                 Request index

-  @param  DevStatus              Device status

-  @param  Status                 Transfer status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  Recipient              Interface/Device/Endpoint.

+  @param  Target                 Request index.

+  @param  DevStatus              Device status.

+  @param  Status                 Transfer status.

 

-  @retval EFI_INVALID_PARAMETER  Parameter is error

-  @retval EFI_SUCCESS            Success

-  @retval EFI_TIMEOUT            Device has no response

+  @retval EFI_INVALID_PARAMETER  Parameter is error.

+  @retval EFI_SUCCESS            Success.

+  @retval EFI_TIMEOUT            Device has no response.

 

 **/

 EFI_STATUS

@@ -504,17 +504,16 @@ UsbGetStatus (
 }

 

 

-

 /**

-  Clear endpoint stall

+  Clear endpoint stall.

 

-  @param  UsbIo                  EFI_USB_IO_PROTOCOL

-  @param  EndpointNo             Endpoint Number

-  @param  Status                 Transfer Status

+  @param  UsbIo                  EFI_USB_IO_PROTOCOL.

+  @param  EndpointNo             Endpoint Number.

+  @param  Status                 Transfer Status.

 

-  @retval EFI_NOT_FOUND          Can't find the Endpoint

-  @retval EFI_DEVICE_ERROR       Hardware error

-  @retval EFI_SUCCESS            Success

+  @retval EFI_NOT_FOUND          Can't find the Endpoint.

+  @retval EFI_DEVICE_ERROR       Hardware error.

+  @retval EFI_SUCCESS            Success.

 

 **/

 EFI_STATUS