update codes per MdePkg doxgen review comments.

[mirror_edk2.git] / MdePkg / Include / Protocol / Hash.h

diff --git a/MdePkg/Include/Protocol/Hash.h b/MdePkg/Include/Protocol/Hash.h
index ef899fe1a58fbe4b26f7c97f7d79da9e26d083a7..6441bfe7a8de8ab7bafb68a9f0cb4766aba0c0c8 100644 (file)
--- a/MdePkg/Include/Protocol/Hash.h
+++ b/MdePkg/Include/Protocol/Hash.h
@@ -2,11 +2,11 @@
   EFI_HASH_SERVICE_BINDING_PROTOCOL as defined in UEFI 2.0.\r
   EFI_HASH_PROTOCOL as defined in UEFI 2.0.\r
   The EFI Hash Service Binding Protocol is used to locate hashing services support \r
-  provided by a driver and create and destroy instances of the EFI Hash Protocol \r
+  provided by a driver and to create and destroy instances of the EFI Hash Protocol \r
   so that a multiple drivers can use the underlying hashing services.\r
   The EFI Service Binding Protocol defines the generic Service Binding Protocol 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
@@ -93,12 +93,11 @@ typedef union {
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HASH_GET_HASH_SIZE) (\r
+(EFIAPI *EFI_HASH_GET_HASH_SIZE)(\r
   IN  CONST EFI_HASH_PROTOCOL     *This,\r
   IN  CONST EFI_GUID              *HashAlgorithm,\r
   OUT UINTN                       *HashSize\r
-  )\r
-;      \r
+  );      \r
 \r
 /**\r
   Returns the size of the hash which results from a specific algorithm.\r
@@ -120,16 +119,19 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_HASH_HASH) (\r
+(EFIAPI *EFI_HASH_HASH)(\r
   IN CONST EFI_HASH_PROTOCOL      *This,\r
   IN CONST EFI_GUID               *HashAlgorithm,\r
   IN BOOLEAN                      Extend,\r
   IN CONST UINT8                  *Message,\r
   IN UINT64                       MessageSize,\r
   IN OUT EFI_HASH_OUTPUT          *Hash\r
-  )\r
-;    \r
+  );    \r
 \r
+///\r
+/// This protocol allows creating a hash of an arbitrary message digest \r
+/// using one or more hash algorithms.\r
+///\r
 struct _EFI_HASH_PROTOCOL {\r
   EFI_HASH_GET_HASH_SIZE          GetHashSize;\r
   EFI_HASH_HASH                   Hash;\r