Make the function comments of FileHandleIsDirectory in FileHandleLib consistent with instance implementation.
Contributed-under: TianoCore Contribution Agreement 1.0 Signed-off-by: Qiu Shumin <shumin....@intel.com> Reviewed-by: Jaben Carsey <jaben.car...@intel.com> --- MdePkg/Include/Library/FileHandleLib.h | 11 +++++------ MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c | 17 ++++++++--------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/MdePkg/Include/Library/FileHandleLib.h b/MdePkg/Include/Library/FileHandleLib.h index 123cc8c..959c2db 100644 --- a/MdePkg/Include/Library/FileHandleLib.h +++ b/MdePkg/Include/Library/FileHandleLib.h @@ -1,7 +1,7 @@ /** @file Provides interface to EFI_FILE_HANDLE functionality. - Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR> + Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -242,15 +242,14 @@ FileHandleFlush ( /** Function to determine if a given handle is a directory handle. - If DirHandle is NULL, then ASSERT(). - - Open the file information on the DirHandle, and verify that the Attribute + Open the file information on the DirHandle and verify that the Attribute includes EFI_FILE_DIRECTORY bit set. - @param[in] DirHandle The handle to open the file. + @param[in] DirHandle Handle to open file. @retval EFI_SUCCESS DirHandle is a directory. - @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available. + @retval EFI_INVALID_PARAMETER DirHandle is NULL. + The file information returns from FileHandleGetInfo is NULL. @retval EFI_NOT_FOUND DirHandle is not a directory. **/ EFI_STATUS diff --git a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c index be66c57..d806169 100644 --- a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c +++ b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c @@ -1,7 +1,7 @@ /** @file Provides interface to EFI_FILE_HANDLE functionality. - Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. <BR> + Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved. <BR> This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at @@ -383,18 +383,17 @@ FileHandleFlush ( } /** - function to determine if a given handle is a directory handle + Function to determine if a given handle is a directory handle. - if DirHandle is NULL then return error - - open the file information on the DirHandle and verify that the Attribute + Open the file information on the DirHandle and verify that the Attribute includes EFI_FILE_DIRECTORY bit set. - @param DirHandle Handle to open file + @param[in] DirHandle Handle to open file. - @retval EFI_SUCCESS DirHandle is a directory - @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available - @retval EFI_NOT_FOUND DirHandle is not a directory + @retval EFI_SUCCESS DirHandle is a directory. + @retval EFI_INVALID_PARAMETER DirHandle is NULL. + The file information returns from FileHandleGetInfo is NULL. + @retval EFI_NOT_FOUND DirHandle is not a directory. **/ EFI_STATUS EFIAPI -- 1.9.5.msysgit.1 ------------------------------------------------------------------------------ _______________________________________________ edk2-devel mailing list edk2-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/edk2-devel
