From: klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Wed, 8 Jul 2009 03:10:33 +0000 (+0000)
Subject: Refine comments.
X-Git-Tag: edk2-stable201903~17514
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=0977c9b214465b0d45cd6cae10524fe5d8ef2f55

Refine comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8794 6f19259b-4bc3-4df7-8a09-765794883524
---

diff --git a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
index e5a35ed958..db302c986a 100644
--- a/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/GenericBdsLib.h
@@ -415,12 +415,14 @@ BdsLibConnectDevicePath (
   );
 
 /**
-  This function will connect all current system handles recursively. The
-  connection will finish until every handle's child handle created if it have.
+  This function will connect all current system handles recursively. 
+  
+  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.
+  If the handle is bus type handler, all childrens also will be connected recursively
+  by gBS->ConnectController().
 
-  @retval EFI_SUCCESS           All handles and it's child handle have been
-                                connected
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
+  @retval EFI_SUCCESS           All handles and it's child handle have been connected
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 
 **/
 EFI_STATUS
@@ -429,13 +431,15 @@ BdsLibConnectAllEfi (
   VOID
   );
 
-
 /**
-  This function will disconnect all current system handles. The disconnection
-  will finish until every handle have been disconnected.
+  This function will disconnect all current system handles. 
+  
+  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
+  If handle is a bus type handle, all childrens also are disconnected recursively by
+  gBS->DisconnectController().
 
   @retval EFI_SUCCESS           All handles have been disconnected
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 
 **/
 EFI_STATUS
diff --git a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
index 7d0254d33c..2b01f5392b 100644
--- a/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
+++ b/IntelFrameworkModulePkg/Library/GenericBdsLib/BdsConnect.c
@@ -191,12 +191,14 @@ BdsLibConnectDevicePath (
 
 
 /**
-  This function will connect all current system handles recursively. The
-  connection will finish until every handle's child handle created if it have.
+  This function will connect all current system handles recursively. 
+  
+  gBS->ConnectController() service is invoked for each handle exist in system handler buffer.
+  If the handle is bus type handler, all childrens also will be connected recursively
+  by gBS->ConnectController().
 
-  @retval EFI_SUCCESS           All handles and it's child handle have been
-                                connected
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
+  @retval EFI_SUCCESS           All handles and it's child handle have been connected
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 
 **/
 EFI_STATUS
@@ -232,13 +234,15 @@ BdsLibConnectAllEfi (
   return EFI_SUCCESS;
 }
 
-
 /**
-  This function will disconnect all current system handles. The disconnection
-  will finish until every handle have been disconnected.
+  This function will disconnect all current system handles. 
+  
+  gBS->DisconnectController() is invoked for each handle exists in system handle buffer.
+  If handle is a bus type handle, all childrens also are disconnected recursively by
+  gBS->DisconnectController().
 
   @retval EFI_SUCCESS           All handles have been disconnected
-  @retval EFI_STATUS            Return the status of gBS->LocateHandleBuffer().
+  @retval EFI_STATUS            Error status returned by of gBS->LocateHandleBuffer().
 
 **/
 EFI_STATUS