From 7064c0a5aa3eabe99be9c143e4abaa73d7139609 Mon Sep 17 00:00:00 2001 From: qwang12 Date: Wed, 19 Nov 2008 13:36:34 +0000 Subject: [PATCH] ECC Cleanup: Update Doxygen comment git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6633 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Universal/DriverSampleDxe/DriverSample.c | 43 +++++++++++++++++-- .../Universal/DriverSampleDxe/DriverSample.h | 4 +- .../Universal/DriverSampleDxe/NVDataStruc.h | 4 +- .../Universal/SetupBrowserDxe/IfrParse.c | 23 ++++++++++ .../Universal/SetupBrowserDxe/Print.c | 4 +- .../Universal/SetupBrowserDxe/Setup.h | 1 - MdeModulePkg/Universal/SetupBrowserDxe/Ui.c | 2 +- MdeModulePkg/Universal/SetupBrowserDxe/Ui.h | 2 +- 8 files changed, 70 insertions(+), 13 deletions(-) diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c index 7199566b93..9e82009e82 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c +++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c @@ -29,6 +29,13 @@ EFI_GUID mInventoryGuid = INVENTORY_GUID; CHAR16 VariableName[] = L"MyIfrNVData"; +/** + Encode the password using a simple algorithm. + + @param Password The string to be encoded. + @param MaxSize The size of the string. + +**/ VOID EncodePassword ( IN CHAR16 *Password, @@ -56,10 +63,19 @@ EncodePassword ( return ; } +/** + Validate the user's password. + + @param PrivateData This driver's private context data. + @param StringId The user's input. + + @retval EFI_SUCCESS The user's input matches the password. + @retval EFI_NOT_READY The user's input does not match the password. +**/ EFI_STATUS ValidatePassword ( - DRIVER_SAMPLE_PRIVATE_DATA *PrivateData, - EFI_STRING_ID StringId + IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData, + IN EFI_STRING_ID StringId ) { EFI_STATUS Status; @@ -138,10 +154,20 @@ ValidatePassword ( return Status; } +/** + Encode the password using a simple algorithm. + + @param PrivateData This driver's private context data. + @param StringId The password from User. + + @retval EFI_SUCESS The operation is successful. + @return Other value if gRT->SetVariable () fails. + +**/ EFI_STATUS SetPassword ( - DRIVER_SAMPLE_PRIVATE_DATA *PrivateData, - EFI_STRING_ID StringId + IN DRIVER_SAMPLE_PRIVATE_DATA *PrivateData, + IN EFI_STRING_ID StringId ) { EFI_STATUS Status; @@ -646,6 +672,15 @@ DriverCallback ( return Status; } +/** + Main entry for this driver. + + @param ImageHandle Image handle this driver. + @param SystemTable Pointer to SystemTable. + + @retval EFI_SUCESS This function always complete successfully. + +**/ EFI_STATUS EFIAPI DriverSampleInit ( diff --git a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h index 1489da22ed..8c20cf26ba 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h +++ b/MdeModulePkg/Universal/DriverSampleDxe/DriverSample.h @@ -21,8 +21,8 @@ Revision History **/ -#ifndef _DRIVER_SAMPLE_H -#define _DRIVER_SAMPLE_H +#ifndef _DRIVER_SAMPLE_H_ +#define _DRIVER_SAMPLE_H_ #include diff --git a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h index 453e474b67..4fbd6a5650 100644 --- a/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h +++ b/MdeModulePkg/Universal/DriverSampleDxe/NVDataStruc.h @@ -22,8 +22,8 @@ Revision History: **/ -#ifndef _NVDATASTRUC_H -#define _NVDATASTRUC_H +#ifndef _NVDATASTRUC_H_ +#define _NVDATASTRUC_H_ #define FORMSET_GUID \ { \ diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c b/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c index cde8d6f10b..fe029a3523 100644 --- a/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c +++ b/MdeModulePkg/Universal/SetupBrowserDxe/IfrParse.c @@ -89,6 +89,21 @@ CreateStatement ( return Statement; } +/** + Convert a numeric value to a Unicode String and insert it to String Package. + This string is used as the Unicode Name for the EFI Variable. This is to support + the deprecated vareqval opcode. + + @param FormSet The FormSet. + @param Statement The numeric question whose VarStoreInfo.VarName is the + numeric value which is used to produce the Unicode Name + for the EFI Variable. + + If the Statement is NULL, the ASSERT. + If the opcode is not Numeric, then ASSERT. + + @retval EFI_SUCCESS The funtion always succeeds. +**/ EFI_STATUS UpdateCheckBoxStringToken ( IN CONST FORM_BROWSER_FORMSET *FormSet, @@ -115,6 +130,14 @@ UpdateCheckBoxStringToken ( return EFI_SUCCESS; } +/** + Check if the next opcode is the EFI_IFR_EXTEND_OP_VAREQNAME. + + @param OpCodeData The current opcode. + + @retval TRUE Yes. + @retval FALSE No. +**/ BOOLEAN IsNextOpCodeGuidedVarEqName ( UINT8 *OpCodeData diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Print.c b/MdeModulePkg/Universal/SetupBrowserDxe/Print.c index d8b42f8973..7bbe6d49ca 100644 --- a/MdeModulePkg/Universal/SetupBrowserDxe/Print.c +++ b/MdeModulePkg/Universal/SetupBrowserDxe/Print.c @@ -165,7 +165,7 @@ PrintInternal ( UINTN ConsolePrint ( IN CHAR16 *Fmt, - IN ... + ... ) { VA_LIST Args; @@ -253,7 +253,7 @@ UINTN PrintStringAt ( IN UINTN Column, IN UINTN Row, - CHAR16 *String + IN CHAR16 *String ) { return PrintAt (Column, Row, L"%s", String); diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h b/MdeModulePkg/Universal/SetupBrowserDxe/Setup.h index 0804d5173f..73669735c0 100644 --- 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 hold the typed in string if HotKey is FALSE @param KeyValue The EFI_KEY value returned if HotKey is TRUE.. - @param String Pointer to the first string in the list @param ... A series of (quantity == NumberOfLines) text strings which will be used to construct the dialog box diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.c index 639854e8a8..9624374550 100644 --- 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() // ConfigAccess = Selection->FormSet->ConfigAccess; - if ((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) && (ConfigAccess != NULL)) { + if (((Question->QuestionFlags & EFI_IFR_FLAG_CALLBACK) != 0) && (ConfigAccess != NULL)) { ActionRequest = EFI_BROWSER_ACTION_REQUEST_NONE; HiiValue = &Question->HiiValue; diff --git a/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h b/MdeModulePkg/Universal/SetupBrowserDxe/Ui.h index 3244cd1dbc..957a739c61 100644 --- 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 strings specified. - @param RequestedWidth The width of the pop-up. + @param ScreenWidth The width of the pop-up. @param NumberOfLines The number of lines. @param ... A series of text strings that displayed in the pop-up.