Minor code enhancement.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Ppi / PciCfg.h

diff --git a/IntelFrameworkPkg/Include/Ppi/PciCfg.h b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
index 247a28b775d334b73de41adabc84eb5df9fb4e27..708e51280df41d8d10a4d996fc4a2ce43ebf31ef 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/PciCfg.h
+++ b/IntelFrameworkPkg/Include/Ppi/PciCfg.h
@@ -1,7 +1,7 @@
 /** @file\r
-  This file declares PciCfg PPI used to access PCI configuration space in PEI\r
+  This file declares the PciCfg PPI used to access the PCI configuration space in PEI\r
 \r
-  Copyright (c) 2006, 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
@@ -10,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  PciCfg.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in PEI CIS\r
   Version 0.91.\r
@@ -21,11 +19,10 @@
 #ifndef __PEI_PCI_CFG_H__\r
 #define __PEI_PCI_CFG_H__\r
 \r
-#include <Pi/PiPeiCis.h>\r
+#include <Ppi/PciCfg2.h>\r
 //\r
 // Get the common definitions for EFI_PEI_PCI_CFG_PPI_WIDTH.\r
 //\r
-#include <Ppi/PciCfg2.h>\r
 \r
 #define EFI_PEI_PCI_CFG_PPI_INSTALLED_GUID \\r
   { \\r
@@ -54,7 +51,7 @@ typedef struct _EFI_PEI_PCI_CFG_PPI   EFI_PEI_PCI_CFG_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_IO) (\r
+(EFIAPI *EFI_PEI_PCI_CFG_PPI_IO)(\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_PCI_CFG_PPI          *This,\r
   IN EFI_PEI_PCI_CFG_PPI_WIDTH    Width,\r
@@ -78,7 +75,7 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_PCI_CFG_PPI_RW) (\r
+(EFIAPI *EFI_PEI_PCI_CFG_PPI_RW)(\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN EFI_PEI_PCI_CFG_PPI          *This,\r
   IN EFI_PEI_PCI_CFG_PPI_WIDTH    Width,\r
@@ -90,20 +87,21 @@ EFI_STATUS
 /**\r
   The EFI_PEI_PCI_CFG_PPI interfaces are used to abstract accesses to PCI \r
   controllers behind a PCI root bridge controller.\r
-\r
-  @param Read\r
-  PCI read services.  See the Read() function description.\r
-\r
-  @param Write\r
-  PCI write services.  See the Write() function description.\r
-\r
-  @param Modify\r
-  PCI read-modify-write services.  See the Modify() function description.\r
-\r
 **/\r
 struct _EFI_PEI_PCI_CFG_PPI {\r
+  ///\r
+  /// PCI read services.  See the Read() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_IO  Read;\r
+  \r
+  ///\r
+  /// PCI write services.  See the Write() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_IO  Write;\r
+  \r
+  ///\r
+  /// PCI read-modify-write services.  See the Modify() function description.\r
+  ///\r
   EFI_PEI_PCI_CFG_PPI_RW  Modify;\r
 };\r
 \r