sync comments, fix function header, rename variable name to follow coding style.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / String.c

diff --git a/MdeModulePkg/Universal/BdsDxe/String.c b/MdeModulePkg/Universal/BdsDxe/String.c
index 84f9f96edf338389cbc57241ded0c7303432cb5d..b78b22f97e1273242fb4fa73c73f97784d174af4 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/String.c
+++ b/MdeModulePkg/Universal/BdsDxe/String.c
@@ -1,6 +1,7 @@
-/*++\r
+/** @file\r
+  String support\r
 \r
-Copyright (c) 2004 - 2008, Intel Corporation\r
+Copyright (c) 2004 - 2008, Intel Corporation. <BR>\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
@@ -9,15 +10,7 @@ http://opensource.org/licenses/bsd-license.php
 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:\r
-\r
-  String.c\r
-\r
-Abstract:\r
-\r
-  String support\r
-\r
---*/\r
+**/\r
 \r
 #include "Bds.h"\r
 #include "Language.h"\r
@@ -29,22 +22,16 @@ EFI_GUID mBdsStringPackGuid = {
   0x7bac95d3, 0xddf, 0x42f3, 0x9e, 0x24, 0x7c, 0x64, 0x49, 0x40, 0x37, 0x9a\r
 };\r
 \r
+/**\r
+  Initialize HII global accessor for string support\r
+\r
+  @retval  EFI_SUCCESS  String support initialize success.\r
+\r
+**/\r
 EFI_STATUS\r
 InitializeStringSupport (\r
   VOID\r
   )\r
-/*++\r
-\r
-Routine Description:\r
-  Initialize HII global accessor for string support\r
-\r
-Arguments:\r
-  None\r
-\r
-Returns:\r
-  EFI_SUCCESS - String support initialize success.\r
-\r
---*/\r
 {\r
   EFI_STATUS                   Status;\r
   EFI_HANDLE                   DriverHandle;\r
@@ -63,7 +50,7 @@ Returns:
     return Status;\r
   }\r
 \r
-  PackageList = PreparePackageList (1, &mBdsStringPackGuid, &BdsStrings);\r
+  PackageList = HiiLibPreparePackageList (1, &mBdsStringPackGuid, &BdsDxeStrings);\r
   ASSERT (PackageList != NULL);\r
 \r
   Status = gHiiDatabase->NewPackageList (\r
@@ -77,28 +64,25 @@ Returns:
   return Status;\r
 }\r
 \r
-CHAR16 *\r
-GetStringById (\r
-  IN  EFI_STRING_ID   Id\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
+/**\r
   Get string by string id from HII Interface\r
 \r
-Arguments:\r
-  Id       - String ID.\r
 \r
-Returns:\r
-  CHAR16 * - String from ID.\r
-  NULL     - If error occurs.\r
+  @param Id              String ID.\r
+\r
+  @retval  CHAR16 *  String from ID.\r
+  @retval  NULL      If error occurs.\r
 \r
---*/\r
+**/\r
+CHAR16 *\r
+GetStringById (\r
+  IN  EFI_STRING_ID   Id\r
+  )\r
 {\r
   CHAR16 *String;\r
 \r
   String = NULL;\r
-  GetStringFromHandle (gStringPackHandle, Id, &String);\r
+  HiiLibGetStringFromHandle (gStringPackHandle, Id, &String);\r
 \r
   return String;\r
 }\r