ECC Cleanup: Update Doxygen comment

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6633 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
qwang12
2008-11-19 13:36:34 +00:00
parent a3a70b6ac1
commit 7064c0a5aa
8 changed files with 70 additions and 13 deletions

View File

@@ -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 (

View File

@@ -21,8 +21,8 @@ Revision History
**/
#ifndef _DRIVER_SAMPLE_H
#define _DRIVER_SAMPLE_H
#ifndef _DRIVER_SAMPLE_H_
#define _DRIVER_SAMPLE_H_
#include <Uefi.h>

View File

@@ -22,8 +22,8 @@ Revision History:
**/
#ifndef _NVDATASTRUC_H
#define _NVDATASTRUC_H
#ifndef _NVDATASTRUC_H_
#define _NVDATASTRUC_H_
#define FORMSET_GUID \
{ \