ECC Cleanup: Update Doxygen comment

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6633 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
index 7199566b936d8ea8959c4d2717aba00ba74d76f0..9e82009e82e2138d2ac97282b152a43947de22a0 100644 (file)
--- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
+++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c
@@ -29,6 +29,13 @@ EFI_GUID   mInventoryGuid = INVENTORY_GUID;
 \r
 CHAR16     VariableName[] = L"MyIfrNVData";\r
 \r
+/**\r
+  Encode the password using a simple algorithm.\r
+  \r
+  @param Password The string to be encoded.\r
+  @param MaxSize  The size of the string.\r
+  \r
+**/\r
 VOID\r
 EncodePassword (\r
   IN  CHAR16                      *Password,\r
@@ -56,10 +63,19 @@ EncodePassword (
   return ;\r
 }\r
 \r
+/**\r
+  Validate the user's password.\r
+  \r
+  @param PrivateData This driver's private context data.\r
+  @param StringId    The user's input.\r
+  \r
+  @retval EFI_SUCCESS   The user's input matches the password.\r
+  @retval EFI_NOT_READY The user's input does not match the password.\r
+**/\r
 EFI_STATUS\r
 ValidatePassword (\r
-  DRIVER_SAMPLE_PRIVATE_DATA      *PrivateData,\r
-  EFI_STRING_ID                   StringId\r
+  IN       DRIVER_SAMPLE_PRIVATE_DATA      *PrivateData,\r
+  IN       EFI_STRING_ID                   StringId\r
   )\r
 {\r
   EFI_STATUS                      Status;\r
@@ -138,10 +154,20 @@ ValidatePassword (
   return Status;\r
 }\r
 \r
+/**\r
+  Encode the password using a simple algorithm.\r
+  \r
+  @param PrivateData This driver's private context data.\r
+  @param StringId    The password from User.\r
+  \r
+  @retval  EFI_SUCESS The operation is successful.\r
+  @return  Other value if gRT->SetVariable () fails.\r
+  \r
+**/\r
 EFI_STATUS\r
 SetPassword (\r
-  DRIVER_SAMPLE_PRIVATE_DATA      *PrivateData,\r
-  EFI_STRING_ID                   StringId\r
+  IN DRIVER_SAMPLE_PRIVATE_DATA      *PrivateData,\r
+  IN EFI_STRING_ID                   StringId\r
   )\r
 {\r
   EFI_STATUS                      Status;\r
@@ -646,6 +672,15 @@ DriverCallback (
   return Status;\r
 }\r
 \r
+/**\r
+  Main entry for this driver.\r
+  \r
+  @param ImageHandle     Image handle this driver.\r
+  @param SystemTable     Pointer to SystemTable.\r
+\r
+  @retval EFI_SUCESS     This function always complete successfully.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DriverSampleInit (\r

diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h
index 1489da22ed76d60a0f4a2aab58b322115a3f1ebb..8c20cf26ba6a71eb15b1d5ba237266e98218faaa 100644 (file)
--- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h
+++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h
@@ -21,8 +21,8 @@ Revision History
 \r
 **/\r
 \r
-#ifndef _DRIVER_SAMPLE_H\r
-#define _DRIVER_SAMPLE_H\r
+#ifndef _DRIVER_SAMPLE_H_\r
+#define _DRIVER_SAMPLE_H_\r
 \r
 #include <Uefi.h>\r
 \r

diff --git a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h
index 453e474b6719b865aacd8dfe7e03fcd75a577514..4fbd6a5650e2724c6f1fb1fffd20163823551985 100644 (file)
--- a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h
+++ b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h
@@ -22,8 +22,8 @@ Revision History:
 \r
 **/\r
 \r
-#ifndef _NVDATASTRUC_H\r
-#define _NVDATASTRUC_H\r
+#ifndef _NVDATASTRUC_H_\r
+#define _NVDATASTRUC_H_\r
 \r
 #define FORMSET_GUID \\r
   { \\r

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

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Print.c b/MdeModulePkg/Universal/SetupBrowserDxe/Print.c
index d8b42f8973713caf87913917db8ef317fd51dc65..7bbe6d49ca4ed31480949feb7e1ccc0f3dc09961 100644 (file)
--- a/MdeModulePkg/Universal/SetupBrowserDxe/Print.c
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/Print.c
@@ -165,7 +165,7 @@ PrintInternal (
 UINTN\r
 ConsolePrint (\r
   IN CHAR16   *Fmt,\r
-  IN ...\r
+  ...\r
   )\r
 {\r
   VA_LIST Args;\r
@@ -253,7 +253,7 @@ UINTN
 PrintStringAt (\r
   IN UINTN     Column,\r
   IN UINTN     Row,\r
-  CHAR16       *String\r
+  IN CHAR16    *String\r
   )\r
 {\r
   return PrintAt (Column, Row, L"%s", String);\r

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h b/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h
index 0804d5173f9b1c525a08971c5286e93ae0efb859..73669735c0bb7fca77bbf97c12af3d86a001228f 100644 (file)
--- a/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h
@@ -712,7 +712,6 @@ CreateSharedPopUp (
   @param  StringBuffer           The passed in pointer to the buffer which will\r
                                  hold the typed in string if HotKey is FALSE\r
   @param  KeyValue               The EFI_KEY value returned if HotKey is TRUE..\r
-  @param  String                 Pointer to the first string in the list\r
   @param  ...                    A series of (quantity == NumberOfLines) text\r
                                  strings which will be used to construct the dialog\r
                                  box\r

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c
index 639854e8a8238d22915e137a584e56c158ae2e44..962437455093a0ce3711e753aa4b0c95543e8729 100644 (file)
--- a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c
@@ -348,7 +348,7 @@ RefreshForm (
       // Question value may be changed, need invoke its Callback()\r
       //\r
       ConfigAccess = Selection->FormSet->ConfigAccess;\r
-      if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) && (ConfigAccess != NULL)) {\r
+      if (((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) && (ConfigAccess != NULL)) {\r
         ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE;\r
 \r
         HiiValue = &Question->HiiValue;\r

diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h
index 3244cd1dbcd7eb10ef21e3581fcdbc2086dccf03..957a739c61523fdcabd49f0319378bd6fd848801 100644 (file)
--- a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h
+++ b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h
@@ -350,7 +350,7 @@ UiWaitForSingleEvent (
   Draw a pop up windows based on the dimension, number of lines and\r
   strings specified.\r
 \r
-  @param RequestedWidth  The width of the pop-up.\r
+  @param ScreenWidth     The width of the pop-up.\r
   @param NumberOfLines   The number of lines.\r
   @param ...             A series of text strings that displayed in the pop-up.\r
 \r