Revision: 14765
          http://sourceforge.net/p/edk2/code/14765
Author:   ydong10
Date:     2013-10-12 02:10:02 +0000 (Sat, 12 Oct 2013)
Log Message:
-----------
Update comments for VarOffset field in the dynamic create question function.

Signed-off-by: Eric Dong <[email protected]>
Reviewed-by: Liming Gao <[email protected]>

Modified Paths:
--------------
    trunk/edk2/MdeModulePkg/Include/Library/HiiLib.h
    trunk/edk2/MdeModulePkg/Library/UefiHiiLib/HiiLib.c

Modified: trunk/edk2/MdeModulePkg/Include/Library/HiiLib.h
===================================================================
--- trunk/edk2/MdeModulePkg/Include/Library/HiiLib.h    2013-10-11 07:37:30 UTC 
(rev 14764)
+++ trunk/edk2/MdeModulePkg/Include/Library/HiiLib.h    2013-10-12 02:10:02 UTC 
(rev 14765)
@@ -732,7 +732,8 @@
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.
   @param[in]  QuestionId            The question ID.
   @param[in]  VarStoreId            The storage ID.
-  @param[in]  VarOffset             The offset in Storage.
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                The string ID for Prompt.
   @param[in]  Help                  The string ID for Help.
   @param[in]  QuestionFlags         The flags in Question Header.
@@ -768,7 +769,8 @@
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.
   @param[in]  QuestionId            The question ID.
   @param[in]  VarStoreId            The storage ID.
-  @param[in]  VarOffset             The offset in Storage.
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                The string ID for Prompt.
   @param[in]  Help                  The string ID for Help.
   @param[in]  QuestionFlags         The flags in Question Header.
@@ -810,7 +812,8 @@
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.
   @param[in]  QuestionId            The question ID.
   @param[in]  VarStoreId            The storage ID.
-  @param[in]  VarOffset             The offset in Storage.
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                The string ID for Prompt.
   @param[in]  Help                  The string ID for Help.
   @param[in]  QuestionFlags         The flags in Question Header.
@@ -850,7 +853,8 @@
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.
   @param[in]  QuestionId            The question ID.
   @param[in]  VarStoreId            The storage ID.
-  @param[in]  VarOffset             The offset in Storage.
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                The string ID for Prompt.
   @param[in]  Help                  The string ID for Help.
   @param[in]  QuestionFlags         The flags in Question Header.
@@ -888,7 +892,8 @@
   @param[in]  OpCodeHandle          The handle to the buffer of opcodes.
   @param[in]  QuestionId            The question ID.
   @param[in]  VarStoreId            The storage ID.
-  @param[in]  VarOffset             The offset in Storage.
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                The string ID for Prompt.
   @param[in]  Help                  The string ID for Help.
   @param[in]  QuestionFlags         The flags in Question Header.
@@ -954,7 +959,8 @@
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID, optional. If DateFlags is not
                                     QF_DATE_STORAGE_NORMAL, this parameter is 
ignored.
-  @param[in]  VarOffset             Offset in Storage, optional. If DateFlags 
is not
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair, optional. If 
DateFlags is not
                                     QF_DATE_STORAGE_NORMAL, this parameter is 
ignored.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
@@ -992,7 +998,8 @@
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID, optional. If TimeFlags is not
                                     QF_TIME_STORAGE_NORMAL, this parameter is 
ignored.
-  @param[in]  VarOffset             Offset in Storage, optional. If TimeFlags 
is not
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair, optional. If 
TimeFlags is not
                                     QF_TIME_STORAGE_NORMAL, this parameter is 
ignored.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help

Modified: trunk/edk2/MdeModulePkg/Library/UefiHiiLib/HiiLib.c
===================================================================
--- trunk/edk2/MdeModulePkg/Library/UefiHiiLib/HiiLib.c 2013-10-11 07:37:30 UTC 
(rev 14764)
+++ trunk/edk2/MdeModulePkg/Library/UefiHiiLib/HiiLib.c 2013-10-12 02:10:02 UTC 
(rev 14765)
@@ -3284,7 +3284,8 @@
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID
-  @param[in]  VarOffset             Offset in Storage
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
   @param[in]  QuestionFlags         Flags in Question Header
@@ -3345,7 +3346,8 @@
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID
-  @param[in]  VarOffset             Offset in Storage
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
   @param[in]  QuestionFlags         Flags in Question Header
@@ -3446,7 +3448,8 @@
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID
-  @param[in]  VarOffset             Offset in Storage
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
   @param[in]  QuestionFlags         Flags in Question Header
@@ -3513,7 +3516,8 @@
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID
-  @param[in]  VarOffset             Offset in Storage
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
   @param[in]  QuestionFlags         Flags in Question Header
@@ -3580,7 +3584,8 @@
   @param[in]  OpCodeHandle          Handle to the buffer of opcodes.
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID
-  @param[in]  VarOffset             Offset in Storage
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
   @param[in]  QuestionFlags         Flags in Question Header
@@ -3682,7 +3687,8 @@
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID, optional. If DateFlags is not
                                     QF_DATE_STORAGE_NORMAL, this parameter is 
ignored.
-  @param[in]  VarOffset             Offset in Storage, optional. If DateFlags 
is not
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair, optional. If 
DateFlags is not
                                     QF_DATE_STORAGE_NORMAL, this parameter is 
ignored.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help
@@ -3746,7 +3752,8 @@
   @param[in]  QuestionId            Question ID
   @param[in]  VarStoreId            Storage ID, optional. If TimeFlags is not
                                     QF_TIME_STORAGE_NORMAL, this parameter is 
ignored.
-  @param[in]  VarOffset             Offset in Storage, optional. If TimeFlags 
is not
+  @param[in]  VarOffset             Offset in Storage or String ID of the name 
(VarName)
+                                    for this name/value pair, optional. If 
TimeFlags is not
                                     QF_TIME_STORAGE_NORMAL, this parameter is 
ignored.
   @param[in]  Prompt                String ID for Prompt
   @param[in]  Help                  String ID for Help

This was sent by the SourceForge.net collaborative development platform, the 
world's largest Open Source development site.


------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
edk2-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/edk2-commits

Reply via email to