modify coding style to pass ecc tool

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

diff --git a/MdePkg/Include/Library/TimerLib.h b/MdePkg/Include/Library/TimerLib.h
index 65bd8549dc92f2cce51230b25b288ccc37ccca7f..3959396e205f5729fe42a2a10c6f25103627469a 100644 (file)
--- a/MdePkg/Include/Library/TimerLib.h
+++ b/MdePkg/Include/Library/TimerLib.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Timer Library Functions\r
+  Timer Library Functions.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -16,8 +16,6 @@
 #define __TIMER_LIB__\r
 \r
 /**\r
-  Stalls the CPU for at least the given number of microseconds.\r
-\r
   Stalls the CPU for the number of microseconds specified by MicroSeconds.\r
 \r
   @param  MicroSeconds  The minimum number of microseconds to delay.\r
@@ -32,8 +30,6 @@ MicroSecondDelay (
   );\r
 \r
 /**\r
-  Stalls the CPU for at least the given number of nanoseconds.\r
-\r
   Stalls the CPU for the number of nanoseconds specified by NanoSeconds.\r
 \r
   @param  NanoSeconds The minimum number of nanoseconds to delay.\r
@@ -48,10 +44,8 @@ NanoSecondDelay (
   );\r
 \r
 /**\r
-  Retrieves the current value of a 64-bit free running performance counter.\r
-\r
-  Retrieves the current value of a 64-bit free running performance counter. The\r
-  counter can either count up by 1 or count down by 1. If the physical\r
+  Retrieves the current value of a 64-bit free running performance counter. \r
+  The counter can either count up by 1 or count down by 1. If the physical\r
   performance counter counts by a larger increment, then the counter values\r
   must be translated. The properties of the counter can be retrieved from\r
   GetPerformanceCounterProperties().\r

diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h
index a77a855230e3d156a26d01c02507953b29b1e07a..4d81b35ee2ad2a702d58fa411323ff8fef5204ea 100644 (file)
--- a/MdePkg/Include/Library/UsbLib.h
+++ b/MdePkg/Include/Library/UsbLib.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Common Dxe Libarary  for USB\r
+  Common Dxe Libarary  for USB.\r
 \r
-  Copyright (c) 2006, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2008, Intel Corporation<BR>\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -24,10 +24,10 @@
 #define TIMEOUT_VALUE 3 * 1000\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             A pointer to 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
@@ -45,9 +45,9 @@ UsbGetHidDescriptor (
 \r
 \r
 /**\r
-  get Report Class descriptor\r
+  get Report Class descriptor.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL.\r
+  @param  UsbIo             A pointer to EFI_USB_IO_PROTOCOL.\r
   @param  InterfaceNum      Report interface number.\r
   @param  DescriptorSize    Length of DescriptorBuffer.\r
   @param  DescriptorBuffer  Caller allocated buffer to store Usb report descriptor\r
@@ -67,10 +67,10 @@ UsbGetReportDescriptor (
   );\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             A pointer to EFI_USB_IO_PROTOCOL.\r
+  @param  Interface         Which interface the caller wants to get protocol.\r
   @param  Protocol          Protocol value returned.\r
 \r
   @return Status of getting Protocol Request through USB I/O\r
@@ -86,10 +86,10 @@ UsbGetProtocolRequest (
   );\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             A pointer to 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 Status of setting Protocol Request through USB I/O\r
@@ -107,7 +107,7 @@ UsbSetProtocolRequest (
 /**\r
   Set Idel request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             A pointer to 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
@@ -128,7 +128,7 @@ UsbSetIdleRequest (
 /**\r
   Get Idel request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             A pointer to 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
@@ -149,7 +149,7 @@ UsbGetIdleRequest (
 /**\r
   Hid Set Report request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             A pointer to 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
@@ -174,7 +174,7 @@ UsbSetReportRequest (
 /**\r
   Hid Set Report request.\r
 \r
-  @param  UsbIo             EFI_USB_IO_PROTOCOL\r
+  @param  UsbIo             A pointer to 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
@@ -197,18 +197,18 @@ UsbGetReportRequest (
   );\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                  A pointer to 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
@@ -223,18 +223,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                  A pointer to 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
@@ -249,16 +249,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                  A pointer to 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
@@ -271,16 +271,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                  A pointer to 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
@@ -293,15 +293,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                  A pointer to 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
@@ -313,15 +313,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                  A pointer to 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
@@ -333,17 +333,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                  A pointer to 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
@@ -357,17 +357,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                  A pointer to 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
@@ -381,17 +381,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                  A pointer to 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
@@ -405,15 +405,15 @@ UsbGetStatus (
   );\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                  A pointer to 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