Add comments for Include header files

[mirror_edk2.git] / IntelFrameworkModulePkg / Include / Protocol / PciHotPlugRequest.h

diff --git a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
index 748ec103d664e4c3503a1c6a40850759e19eb568..996b5b3265bed955d072bf2e7cb1553194612286 100644 (file)
--- a/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/PciHotPlugRequest.h
@@ -1,6 +1,7 @@
 /** @file\r
+  This protocol is used to add or remove all PCI child devices on the PCI root bridge.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+Copyright (c) 2006 - 2009, Intel Corporation                                                         \r
 All rights reserved. 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
@@ -24,6 +25,19 @@ typedef enum {
 \r
 typedef struct _EFI_PCI_HOTPLUG_REQUEST_PROTOCOL  EFI_PCI_HOTPLUG_REQUEST_PROTOCOL;\r
 \r
+/**\r
+  Hot plug request notify.\r
+  \r
+  @param This                 A pointer to the hot plug request protocol.\r
+  @param Operation            The operation.\r
+  @param Controller           A pointer to the controller.\r
+  @param RemainingDevicePath  A pointer to the device path.\r
+  @param NumberOfChildren     A the number of child handle in the ChildHandleBuffer.\r
+  @param ChildHandleBuffer    A pointer to the array contain the child handle.\r
+  \r
+  @retval EFI_NOT_FOUND Can not find bridge according to controller handle.\r
+  @retval EFI_SUCCESS   Success operating.\r
+**/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PCI_HOTPLUG_REQUEST_NOTIFY) (\r