Formalize comments for Protocols and PPIs.

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

diff --git a/MdePkg/Include/Protocol/Hash.h b/MdePkg/Include/Protocol/Hash.h
index 9355da4fffe4a39a34db42f66e0cc8d9e8687393..fe8c9011a0b7e720a1c33938d8d13e16b6299a80 100644 (file)
--- a/MdePkg/Include/Protocol/Hash.h
+++ b/MdePkg/Include/Protocol/Hash.h
@@ -6,7 +6,7 @@
   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
@@ -15,8 +15,6 @@
   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:  Hash.h\r
-\r
 **/\r
 \r
 #ifndef __EFI_HASH_PROTOCOL_H__\r
@@ -95,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
@@ -122,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