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

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

diff --git a/MdeModulePkg/Universal/BdsDxe/String.h b/MdeModulePkg/Universal/BdsDxe/String.h
index 14c42a95d092e33b08f08dbd5e39a013d08e543d..81a7a6035acea3459c695e007c971d82a96b8c71 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/String.h
+++ b/MdeModulePkg/Universal/BdsDxe/String.h
@@ -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,17 +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.h\r
-\r
-Abstract:\r
-\r
-  String support\r
-\r
-Revision History\r
-\r
---*/\r
+**/\r
 \r
 #ifndef _STRING_H_\r
 #define _STRING_H_\r
@@ -33,7 +24,7 @@ extern EFI_HII_HANDLE gStringPackHandle;
 // string identifiers.\r
 //\r
 \r
-extern UINT8  BdsStrings[];\r
+extern UINT8  BdsDxeStrings[];\r
 \r
 //\r
 // String Definition Guid for BDS Platform\r
@@ -43,16 +34,39 @@ extern UINT8  BdsStrings[];
     0x7777E939, 0xD57E, 0x4DCB, 0xA0, 0x8E, 0x64, 0xD7, 0x98, 0x57, 0x1E, 0x0F \\r
   }\r
 \r
+/**\r
+  Get string by string id from HII Interface\r
+\r
+\r
+  @param Id              String ID.\r
+\r
+  @retval  CHAR16 *  String from ID.\r
+  @retval  NULL      If error occurs.\r
+\r
+**/\r
 CHAR16 *\r
 GetStringById (\r
   IN  EFI_STRING_ID   Id\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
+  Call the browser and display the front page\r
+\r
+  @return   Status code that will be returned by\r
+            EFI_FORM_BROWSER2_PROTOCOL.SendForm ().\r
+\r
+**/\r
 EFI_STATUS\r
 CallFrontPage (\r
   VOID\r