From 7064c0a5aa3eabe99be9c143e4abaa73d7139609 Mon Sep 17 00:00:00 2001
From: qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 19 Nov 2008 13:36:34 +0000
Subject: 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 ++++++++++++++++++++--
 1 file changed, 39 insertions(+), 4 deletions(-)

(limited to 'MdeModulePkg/Universal/DriverSampleDxe/DriverSample.c')

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 (
-- 
cgit v1.2.3