Committing changes to the comments, to improve code documentation.

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

diff --git a/MdeModulePkg/Include/Library/CapsuleLib.h b/MdeModulePkg/Include/Library/CapsuleLib.h
index 80df80e6289c98659a5e5c7c41ab7c570be3e532..34e71313d3b80c16b8036a159253a924f74ee511 100644 (file)
--- a/MdeModulePkg/Include/Library/CapsuleLib.h
+++ b/MdeModulePkg/Include/Library/CapsuleLib.h
@@ -1,9 +1,8 @@
 /** @file\r
 \r
-  Capsule Library. This library class defines a set of interfaces on \r
-  how to process capusle image update.\r
+  This library class defines a set of interfaces for how to process capsule image updates.\r
 \r
-  Copyright (c) 2007, Intel Corporation\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
@@ -18,7 +17,8 @@
 #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
@@ -29,24 +29,21 @@ 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_SUCESS       Capsule Image was processed successfully. \r
   @retval EFI_UNSUPPORTED  Capsule image is not supported by the firmware.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r
 ProcessCapsuleImage (\r
   IN EFI_CAPSULE_HEADER *CapsuleHeader\r
-  )\r
-;\r
+  );\r
 \r
 #endif\r
-\r
-\r