Correct comments to match function declaration.
[efi/edk2/.git] / edk2 / MdeModulePkg / Include / Library / HiiLib.h
index e39ed8e..f63f313 100644 (file)
@@ -1,7 +1,7 @@
 /** @file\r
   Public include file for the HII Library\r
 \r
-  Copyright (c) 2007 - 2009, Intel Corporation                                                         \r
+  Copyright (c) 2007 - 2010, 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
@@ -354,12 +354,12 @@ HiiIsConfigHdrMatch (
   Retrieves uncommitted data from the Form Browser and converts it to a binary\r
   buffer.\r
 \r
-  @param[in]  VariableName  Pointer to a Null-terminated Unicode string.  This \r
-                            is an optional parameter that may be NULL.\r
   @param[in]  VariableGuid  Pointer to an EFI_GUID structure.  This is an optional \r
                             parameter that may be NULL.\r
-  @param[in]  BufferSize    Length in bytes of buffer to hold retrived data. \r
-  @param[out] Block         Buffer of data to be updated.\r
+  @param[in]  VariableName  Pointer to a Null-terminated Unicode string.  This \r
+                            is an optional parameter that may be NULL.\r
+  @param[in]  BufferSize    Length in bytes of buffer to hold retrieved data. \r
+  @param[out] Buffer        Buffer of data to be updated.\r
 \r
   @retval FALSE  The uncommitted data could not be retrieved.\r
   @retval TRUE   The uncommitted data was retrieved.\r
@@ -370,8 +370,8 @@ EFIAPI
 HiiGetBrowserData (\r
   IN CONST EFI_GUID  *VariableGuid,  OPTIONAL\r
   IN CONST CHAR16    *VariableName,  OPTIONAL\r
-  IN UINTN           BlockSize,\r
-  OUT UINT8          *Block\r
+  IN UINTN           BufferSize,\r
+  OUT UINT8          *Buffer\r
   );\r
 \r
 /**\r
@@ -379,10 +379,10 @@ HiiGetBrowserData (
 \r
   If Buffer is NULL, then ASSERT().\r
 \r
-  @param[in]  VariableName    Pointer to a Null-terminated Unicode string.  This\r
-                              is an optional parameter that may be NULL.\r
   @param[in]  VariableGuid    Pointer to an EFI_GUID structure.  This is an optional\r
                               parameter that may be NULL.\r
+  @param[in]  VariableName    Pointer to a Null-terminated Unicode string.  This\r
+                              is an optional parameter that may be NULL.\r
   @param[in]  BufferSize      Length, in bytes, of Buffer.\r
   @param[in]  Buffer          Buffer of data to commit.\r
   @param[in]  RequestElement  An optional field to specify which part of the\r
@@ -428,7 +428,7 @@ HiiSetBrowserData (
   (UINT64)((Hour & 0xff) | ((Minute & 0xff) << 8) | ((Second & 0xff) << 16))\r
 \r
 /**\r
-  Returns a UINT64 value that contains bitfields for Year, Month, and Day.\r
+  Returns a UINT64 value that contains bit fields for Year, Month, and Day.\r
   The lower 16-bits of Year are placed in bits 0..15.  The lower 8-bits of Month \r
   are placed in bits 16..23, and the lower 8-bits of Day are placed in bits \r
   24..31.  This format is selected because it can be easily translated to \r
@@ -458,12 +458,14 @@ HiiAllocateOpCodeHandle (
   );\r
 \r
 /**\r
-  Frees an OpCode Handle that was peviously allocated with HiiAllocateOpCodeHandle().\r
+  Frees an OpCode Handle that was previously allocated with HiiAllocateOpCodeHandle().\r
   When an OpCode Handle is freed, all of the opcodes associated with the OpCode\r
   Handle are also freed.\r
 \r
   If OpCodeHandle is NULL, then ASSERT().\r
 \r
+  @param[in]  OpCodeHandle   Handle to the buffer of opcodes.\r
+\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -632,7 +634,7 @@ HiiCreateActionOpCode (
   @param[in]  Prompt      String ID for Prompt\r
   @param[in]  Help        String ID for Help\r
   @param[in]  Flags       Subtitle opcode flags\r
-  @param[in]  Scope       1 if this opcpde is the beginning of a new scope.\r
+  @param[in]  Scope       1 if this opcode is the beginning of a new scope.\r
                           0 if this opcode is within the current scope.\r
 \r
   @retval NULL   There is not enough space left in Buffer to add the opcode.\r
@@ -882,22 +884,22 @@ HiiCreateOrderedListOpCode (
   The form to update is specified by Handle, FormSetGuid, and FormId.  Binary \r
   comparisons of IFR opcodes are performed from the beginning of the form being \r
   updated until an IFR opcode is found that exactly matches the first IFR opcode \r
-  specifed by StartOpCodeHandle.  The following rules are used to determine if\r
+  specified by StartOpCodeHandle.  The following rules are used to determine if\r
   an insert, replace, or delete operation is performed:\r
   \r
   1) If no matches are found, then NULL is returned.  \r
   2) If a match is found, and EndOpCodeHandle is NULL, then all of the IFR opcodes\r
-     from StartOpcodeHandle except the first opcode are inserted immediately after \r
-     the matching IFR opcode in the form beng updated.\r
+     from StartOpCodeHandle except the first opcode are inserted immediately after \r
+     the matching IFR opcode in the form to be updated.\r
   3) If a match is found, and EndOpCodeHandle is not NULL, then a search is made \r
      from the matching IFR opcode until an IFR opcode exactly matches the first \r
      IFR opcode specified by EndOpCodeHandle.  If no match is found for the first\r
      IFR opcode specified by EndOpCodeHandle, then NULL is returned.  If a match\r
      is found, then all of the IFR opcodes between the start match and the end \r
      match are deleted from the form being updated and all of the IFR opcodes\r
-     from StartOpcodeHandle except the first opcode are inserted immediately after \r
+     from StartOpCodeHandle except the first opcode are inserted immediately after \r
      the matching start IFR opcode.  If StartOpCcodeHandle only contains one\r
-     IFR instruction, then the result of ths operation will delete all of the IFR\r
+     IFR instruction, then the result of this operation will delete all of the IFR\r
      opcodes between the start end matches.\r
 \r
   If HiiHandle is NULL, then ASSERT().\r
@@ -938,8 +940,8 @@ HiiUpdateForm (
   IN EFI_HII_HANDLE  HiiHandle,\r
   IN EFI_GUID        *FormSetGuid,        OPTIONAL\r
   IN EFI_FORM_ID     FormId,\r
-  IN VOID            *StartOpcodeHandle,\r
-  IN VOID            *EndOpcodeHandle     OPTIONAL\r
+  IN VOID            *StartOpCodeHandle,\r
+  IN VOID            *EndOpCodeHandle     OPTIONAL\r
   );\r
 \r
 #endif\r