Code scrub for the following drivers and librarys.

[mirror_edk2.git] / MdeModulePkg / Include / Library / CapsuleLib.h

diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index b8691bc4aba98a56d94f30289a343749cd2505c7..662e4def951c2653a5939d9ddef00ff187507b3a 100644 (file)
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -1,8 +1,8 @@
 /** @file\r
-  Capsule Library. This library class defines a set of interfaces on \r
-  how to process capusle image update.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  This library class defines a set of interfaces on how to process capusle image update.\r
+\r
+  Copyright (c) 2007 - 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
@@ -17,7 +17,10 @@
 #define __CAPSULE_LIB_H__\r
 \r
 /**\r
-  Those capsules supported by the firmwares.\r
+  The firmware checks whether the capsule image is supported \r
+  by the CapsuleGuid in CapsuleHeader or other specific information in capsule image.\r
+  \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be checked.\r
   \r
   @retval EFI_SUCESS       Input capsule is supported by firmware.\r
   @retval EFI_UNSUPPORTED  Input capsule is not supported by the firmware.\r
@@ -26,12 +29,14 @@ EFI_STATUS
 EFIAPI\r
 SupportCapsuleImage (\r
   IN EFI_CAPSULE_HEADER *CapsuleHeader\r
-  )\r
-;\r
+  );\r
 \r
 /**\r
-  The firmware implements to process the capsule image.\r
+  The firmware specific implementation processes the capsule image\r
+  if it recognized the format of this capsule image.\r
   \r
+  @param  CapsuleHeader    Point to the UEFI capsule image to be processed. \r
+   \r
   @retval EFI_SUCESS       Process Capsule Image successfully. \r
   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.\r
 **/\r
@@ -39,9 +44,6 @@ EFI_STATUS
 EFIAPI\r
 ProcessCapsuleImage (\r
   IN EFI_CAPSULE_HEADER *CapsuleHeader\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
-\r
-\r