modify coding style to pass ecc tool

[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseDxe / MouseHid.h

diff --git a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
index 80211341a2228a2c79aa2d5388748e4c1b4fe2ac..478bccffe9822e968ce6600bfd9d98285ff2e580 100644 (file)
--- a/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
+++ b/MdeModulePkg/Bus/Usb/UsbMouseDxe/MouseHid.h
@@ -1,6 +1,8 @@
 /** @file\r
 \r
-Copyright (c) 2004, Intel Corporation\r
+  The interface of HID data structure.\r
+\r
+Copyright (c) 2004 - 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
@@ -9,17 +11,10 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  MouseHid.h\r
-\r
-Abstract:\r
-\r
-\r
 **/\r
 \r
-#ifndef __MOUSE_HID_H\r
-#define __MOUSE_HID_H\r
+#ifndef _EFI_MOUSE_HID_H_\r
+#define _EFI_MOUSE_HID_H_\r
 \r
 #include "UsbMouse.h"\r
 \r
@@ -75,6 +70,17 @@ typedef struct {
   UINT32          CollectionStackPtr;\r
 } HID_PARSER;\r
 \r
+/**\r
+  Parse Mouse Report Descriptor.\r
+\r
+  @param  UsbMouse          The instance of USB_MOUSE_DEV\r
+  @param  ReportDescriptor  Report descriptor to parse\r
+  @param  ReportSize        Report descriptor size\r
+\r
+  @retval EFI_DEVICE_ERROR  Report descriptor error\r
+  @retval EFI_SUCCESS       Parse descriptor success\r
+\r
+**/\r
 EFI_STATUS\r
 ParseMouseReportDescriptor (\r
   IN  USB_MOUSE_DEV   *UsbMouse,\r