Update the copyright notice format

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

diff --git a/MdePkg/Include/Protocol/HiiString.h b/MdePkg/Include/Protocol/HiiString.h
index d0b7e0d2218bd368658c0e66369d9bb781963a55..3deeac033a1bbd1976e6839c9b41602b4bf33ebb 100644 (file)
--- a/MdePkg/Include/Protocol/HiiString.h
+++ b/MdePkg/Include/Protocol/HiiString.h
@@ -1,14 +1,14 @@
 /** @file\r
   The file provides services to manipulate string data.\r
   \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
-  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
@@ -24,10 +24,12 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
 \r
 /**\r
   This function adds the string String to the group of strings owned by PackageList, with the\r
-  specified font information StringFontInfo and returns a new string id.\r
+  specified font information StringFontInfo, and returns a new string id.\r
+  The new string identifier is guaranteed to be unique within the package list. \r
+  That new string identifier is reserved for all languages in the package list. \r
 \r
   @param  This                   A pointer to the EFI_HII_STRING_PROTOCOL instance.\r
-  @param  PackageList            Handle of the package list where this string will\r
+  @param  PackageList            The handle of the package list where this string will\r
                                  be added.\r
   @param  StringId               On return, contains the new strings id, which is\r
                                  unique within PackageList.\r
@@ -36,7 +38,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
                                  with the passed in  Language field.If LanguageName\r
                                  is not NULL and the string package header's\r
                                  LanguageName  associated with a given Language is\r
-                                 not zero, the LanguageName being passed  in will\r
+                                 not zero, the LanguageName being passed in will\r
                                  be ignored.\r
   @param  String                 Points to the new null-terminated string.\r
   @param  StringFontInfo         Points to the new string's font information or\r
@@ -47,7 +49,7 @@ typedef struct _EFI_HII_STRING_PROTOCOL EFI_HII_STRING_PROTOCOL;
   @retval EFI_NOT_FOUND          The specified PackageList could not be found in\r
                                  database.\r
   @retval EFI_OUT_OF_RESOURCES   Could not add the string due to lack of resources.\r
-  @retval EFI_INVALID_PARAMETER  String is NULL or StringId is NULL or Language is NULL.\r
+  @retval EFI_INVALID_PARAMETER  String is NULL, or StringId is NULL, or Language is NULL.\r
   @retval EFI_INVALID_PARAMETER  The specified StringFontInfo does not exist in\r
                                  current database.\r
 \r