MdePkg: Refine the comments for FileHandleIsDirectory.

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.qiu@intel.com>
Reviewed-by: Jaben Carsey <jaben.carsey@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@17630 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/FileHandleLib.h b/MdePkg/Include/Library/FileHandleLib.h
index 123cc8c58f61ab7ea25fad3f2c6f4af4af6547d1..ed4d636fdd54da47544aecc828bf515d142dfe86 100644 (file)
--- a/MdePkg/Include/Library/FileHandleLib.h
+++ b/MdePkg/Include/Library/FileHandleLib.h
@@ -1,7 +1,7 @@
 /** @file\r
   Provides interface to EFI_FILE_HANDLE functionality.\r
 \r
-  Copyright (c) 2009 - 2014, Intel Corporation. All rights reserved.<BR>\r
+  Copyright (c) 2009 - 2015, 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
@@ -242,15 +242,14 @@ FileHandleFlush (
 /**\r
   Function to determine if a given handle is a directory handle.\r
 \r
-  If DirHandle is NULL, then ASSERT().\r
-\r
-  Open the file information on the DirHandle, and verify that the Attribute\r
+  Open the file information on the DirHandle and verify that the Attribute\r
   includes EFI_FILE_DIRECTORY bit set.\r
 \r
-  @param[in] DirHandle          The handle to open the file.\r
+  @param[in] DirHandle          Handle to open file.\r
 \r
   @retval EFI_SUCCESS           DirHandle is a directory.\r
-  @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available.\r
+  @retval EFI_INVALID_PARAMETER DirHandle is NULL. \r
+                                The file information returns from FileHandleGetInfo is NULL. \r
   @retval EFI_NOT_FOUND         DirHandle is not a directory.\r
 **/\r
 EFI_STATUS\r

diff --git a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
index be66c57bb8f50e67826e4ced1eef4354188de0cd..a9d7376cd4383d861341944cbc1b8dfdad48ae82 100644 (file)
--- a/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
+++ b/MdePkg/Library/UefiFileHandleLib/UefiFileHandleLib.c
@@ -1,7 +1,7 @@
 /** @file\r
   Provides interface to EFI_FILE_HANDLE functionality.\r
 \r
-  Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved. <BR>\r
+  Copyright (c) 2006 - 2015, 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
@@ -383,18 +383,17 @@ FileHandleFlush (
 }\r
 \r
 /**\r
-  function to determine if a given handle is a directory handle\r
+  Function to determine if a given handle is a directory handle.\r
 \r
-  if DirHandle is NULL then return error\r
-\r
-  open the file information on the DirHandle and verify that the Attribute\r
+  Open the file information on the DirHandle and verify that the Attribute\r
   includes EFI_FILE_DIRECTORY bit set.\r
 \r
-  @param DirHandle              Handle to open file\r
+  @param[in] DirHandle          Handle to open file.\r
 \r
-  @retval EFI_SUCCESS           DirHandle is a directory\r
-  @retval EFI_INVALID_PARAMETER DirHandle did not have EFI_FILE_INFO available\r
-  @retval EFI_NOT_FOUND         DirHandle is not a directory\r
+  @retval EFI_SUCCESS           DirHandle is a directory.\r
+  @retval EFI_INVALID_PARAMETER DirHandle is NULL. \r
+                                The file information returns from FileHandleGetInfo is NULL. \r
+  @retval EFI_NOT_FOUND         DirHandle is not a directory.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r