Correct function comments on DxeServicesLib GetFileBufferByFilePath API.

Signed-off-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13199 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h
index 596487da57deba72a495f8a3a5df054b0d2677e0..e01dd49c872a511c4b0ccb4fd71f40aca94f145e 100644 (file)
--- a/MdePkg/Include/Library/DxeServicesLib.h
+++ b/MdePkg/Include/Library/DxeServicesLib.h
@@ -2,7 +2,7 @@
   MDE DXE Services Library provides functions that simplify the development of DXE Drivers.  \r
   These functions help access data from sections of FFS files or from file path.\r
 \r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.<BR>\r
 This program and the accompanying materials are licensed and made available under \r
 the terms and conditions of the BSD License that accompanies this distribution.  \r
 The full text of the license may be found at\r
@@ -235,7 +235,7 @@ GetSectionFromFfs (
   \r
   Allocate memory to store the found image. The caller is responsible to free memory.\r
 \r
-  If File is NULL, then NULL is returned.\r
+  If FilePath is NULL, then NULL is returned.\r
   If FileSize is NULL, then NULL is returned.\r
   If AuthenticationStatus is NULL, then NULL is returned.\r
 \r
@@ -248,10 +248,9 @@ GetSectionFromFfs (
   @param[in]       FilePath             Pointer to the device path of the file that is abstracted to\r
                                         the file buffer.\r
   @param[out]      FileSize             Pointer to the size of the abstracted file buffer.\r
-  @param[out]      AuthenticationStatus Pointer to a caller-allocated UINT32 in which the authentication\r
-                                        status is returned.\r
+  @param[out]      AuthenticationStatus Pointer to the authentication status.\r
 \r
-  @retval NULL   File is NULL, or FileSize is NULL, or the file can't be found.\r
+  @retval NULL   FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.\r
   @retval other  The abstracted file buffer. The caller is responsible to free memory.\r
 **/\r
 VOID *\r

diff --git a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c
index 5c4a182a4a5a59bb371cafde54864be31a6dabeb..ef7c9ba9b288f393093d593ce13404bc4e05ce27 100644 (file)
--- a/MdePkg/Library/DxeServicesLib/DxeServicesLib.c
+++ b/MdePkg/Library/DxeServicesLib/DxeServicesLib.c
@@ -2,7 +2,7 @@
   MDE DXE Services Library provides functions that simplify the development of DXE Drivers.  \r
   These functions help access data from sections of FFS files or from file path.\r
 \r
-  Copyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2007 - 2012, Intel Corporation. All rights reserved.<BR>\r
   This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
   which accompanies this distribution.  The full text of the license may be found at\r
@@ -578,7 +578,7 @@ GetSectionFromFfs (
   \r
   Allocate memory to store the found image. The caller is responsible to free memory.\r
 \r
-  If File is NULL, then NULL is returned.\r
+  If FilePath is NULL, then NULL is returned.\r
   If FileSize is NULL, then NULL is returned.\r
   If AuthenticationStatus is NULL, then NULL is returned.\r
 \r
@@ -592,10 +592,9 @@ GetSectionFromFfs (
                                         that is absracted to the file buffer.\r
   @param[out]      FileSize             The pointer to the size of the abstracted \r
                                         file buffer.\r
-  @param[out]      AuthenticationStatus The pointer to a caller-allocated UINT32 \r
-                                        in which the authentication status is returned.\r
+  @param[out]      AuthenticationStatus Pointer to the authentication status.\r
 \r
-  @retval NULL   File is NULL, or FileSize is NULL. Or, the file can't be found.\r
+  @retval NULL   FilePath is NULL, or FileSize is NULL, or AuthenticationStatus is NULL, or the file can't be found.\r
   @retval other  The abstracted file buffer. The caller is responsible to free memory.\r
 **/\r
 VOID *\r