]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/Hash.h
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Include / Protocol / Hash.h
index fda852fd9018ebbb8c3d13bba9e03de4760352a8..2034b0a378406190c5ed49de6c32e92e63199562 100644 (file)
@@ -4,16 +4,15 @@
   The EFI Hash Service Binding Protocol is used to locate hashing services support \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 - 2009, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
-\r
-  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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+This program and the accompanying materials are licensed and made available under \r
+the terms and conditions of the BSD License that accompanies this distribution.  \r
+The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php.                                          \r
+    \r
+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
 **/\r
 \r
@@ -81,9 +80,9 @@ typedef union {
 /**\r
   Returns the size of the hash which results from a specific algorithm.\r
 \r
-  @param  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
-  @param  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
-  @param  HashSize              Holds the returned size of the algorithm's hash.\r
+  @param[in]  This                  Points to this instance of EFI_HASH_PROTOCOL.\r
+  @param[in]  HashAlgorithm         Points to the EFI_GUID which identifies the algorithm to use.\r
+  @param[out] HashSize              Holds the returned size of the algorithm's hash.\r
 \r
   @retval EFI_SUCCESS           Hash size returned successfully.\r
   @retval EFI_INVALID_PARAMETER HashSize is NULL\r
@@ -102,19 +101,19 @@ EFI_STATUS
 /**\r
   Returns the size of the hash which results from a specific algorithm.\r
 \r
-  @param  This          Points to this instance of EFI_HASH_PROTOCOL.\r
-  @param  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
-  @param  Extend        Specifies whether to create a new hash (FALSE) or extend the specified\r
-                        existing hash (TRUE).\r
-  @param  Message       Points to the start of the message.\r
-  @param  MessageSize   The size of Message, in bytes.\r
-  @param  Hash          On input, if Extend is TRUE, then this holds the hash to extend. On\r
-                        output, holds the resulting hash computed from the message.\r
+  @param[in]  This          Points to this instance of EFI_HASH_PROTOCOL.\r
+  @param[in]  HashAlgorithm Points to the EFI_GUID which identifies the algorithm to use.\r
+  @param[in]  Extend        Specifies whether to create a new hash (FALSE) or extend the specified\r
+                            existing hash (TRUE).\r
+  @param[in]  Message       Points to the start of the message.\r
+  @param[in]  MessageSize   The size of Message, in bytes.\r
+  @param[in,out]  Hash      On input, if Extend is TRUE, then this holds the hash to extend. On\r
+                            output, holds the resulting hash computed from the message.\r
 \r
   @retval EFI_SUCCESS           Hash returned successfully.\r
   @retval EFI_INVALID_PARAMETER Message or Hash is NULL\r
   @retval EFI_UNSUPPORTED       The algorithm specified by HashAlgorithm is not supported by this\r
-                                 driver. Or extend is TRUE and the algorithm doesn't support extending the hash.\r
+                                 driver. Or, Extend is TRUE, and the algorithm doesn't support extending the hash.\r
 \r
 **/\r
 typedef\r