ECC Cleanup: Update Doxygen comment

[mirror_edk2.git] / MdeModulePkg / Universal / SetupBrowserDxe / IfrParse.c

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c b/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
index cde8d6f10b6528b6eda63abb2bc6245422dc62a1..fe029a35234c84c0f6913f1eba9f22a53340818f 100644 (file)
--- a/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c
@@ -89,6 +89,21 @@ CreateStatement (
   return Statement;\r
 }\r
 \r
+/**\r
+  Convert a numeric value to a Unicode String and insert it to String Package.\r
+  This string is used as the Unicode Name for the EFI Variable. This is to support\r
+  the deprecated vareqval opcode.\r
+  \r
+  @param FormSet        The FormSet.\r
+  @param Statement      The numeric question whose VarStoreInfo.VarName is the\r
+                        numeric value which is used to produce the Unicode Name\r
+                        for the EFI Variable.\r
+                        \r
+  If the Statement is NULL, the ASSERT.\r
+  If the opcode is not Numeric, then ASSERT.\r
+  \r
+  @retval EFI_SUCCESS The funtion always succeeds.\r
+**/\r
 EFI_STATUS\r
 UpdateCheckBoxStringToken (\r
   IN CONST FORM_BROWSER_FORMSET *FormSet,\r
@@ -115,6 +130,14 @@ UpdateCheckBoxStringToken (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Check if the next opcode is the EFI_IFR_EXTEND_OP_VAREQNAME.\r
+  \r
+  @param OpCodeData     The current opcode.\r
+                        \r
+  @retval TRUE Yes.\r
+  @retval FALSE No.\r
+**/\r
 BOOLEAN\r
 IsNextOpCodeGuidedVarEqName (\r
   UINT8 *OpCodeData\r