Per code review, Update Doxygen comments - add /// comments to protocol struct

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / PciPlatform.h

diff --git a/IntelFrameworkPkg/Include/Protocol/PciPlatform.h b/IntelFrameworkPkg/Include/Protocol/PciPlatform.h
index 97d9af99c1dfdae004f3e024e0d9d323000859c8..d9c198cc0c30beee8e359a8cd9517049774fbaeb 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/PciPlatform.h
+++ b/IntelFrameworkPkg/Include/Protocol/PciPlatform.h
@@ -98,8 +98,8 @@ typedef enum {
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY)(\r
-  IN EFI_PCI_PLATFORM_PROTOCOL                       *This,\r
-  IN  EFI_HANDLE                                     HostBridge,\r
+  IN  EFI_PCI_PLATFORM_PROTOCOL                       *This,\r
+  IN  EFI_HANDLE                                                                                       HostBridge,\r
   IN  EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE  Phase,\r
   IN  EFI_PCI_CHIPSET_EXECUTION_PHASE                ChipsetPhase\r
 );\r
@@ -209,9 +209,23 @@ EFI_STATUS
 /// the unique features of a platform.\r
 ///\r
 struct _EFI_PCI_PLATFORM_PROTOCOL {\r
+       ///\r
+       /// The notification from the PCI bus enumerator to the platform that it is about to \r
+       /// enter a certain phase during the enumeration process.\r
+       ///\r
   EFI_PCI_PLATFORM_PHASE_NOTIFY          PlatformNotify;\r
+       ///\r
+       /// The notification from the PCI bus enumerator to the platform for each PCI \r
+       /// controller at several predefined points during PCI controller initialization.\r
+       /// \r
   EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController;\r
+       /// \r
+       /// Retrieves the platform policy regarding enumeration.\r
+       ///\r
   EFI_PCI_PLATFORM_GET_PLATFORM_POLICY   GetPlatformPolicy;\r
+       ///\r
+       /// Gets the PCI device\92s option ROM from a platform-specific location.\r
+       ///\r
   EFI_PCI_PLATFORM_GET_PCI_ROM           GetPciRom;\r
 };\r
 \r