Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/Smbus.h b/IntelFrameworkPkg/Include/Ppi/Smbus.h
index dff06ce7bb89b03ee572236b662420f073588a91..77f52af66ab02d5d6259356382357639aeb767a7 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/Smbus.h
+++ b/IntelFrameworkPkg/Include/Ppi/Smbus.h
@@ -2,7 +2,7 @@
   This file declares Smbus PPI which provides the basic I/O interfaces that a PEIM \r
   uses to access its SMBus controller and the slave devices attached to it.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -183,29 +183,30 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Ppi Description:\r
   Provides the basic I/O interfaces that a PEIM uses to access\r
   its SMBus controller and the slave devices attached to it.\r
-\r
-  @param Execute\r
-  Executes the SMBus operation to an SMBus slave device.\r
-\r
-  @param ArpDevice\r
-  Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
-\r
-  @param GetArpMap\r
-  Allows a PEIM to retrieve the address that was allocated by the SMBus\r
-  host controller during enumeration/ARP.\r
-\r
-  @param Notify\r
-  Allows a driver to register for a callback to the SMBus host\r
-  controller driver when the bus issues a notification to the bus controller PEIM.\r
-\r
 **/\r
 struct _EFI_PEI_SMBUS_PPI {\r
+  ///\r
+  /// Executes the SMBus operation to an SMBus slave device.\r
+  ///\r
   EFI_PEI_SMBUS_PPI_EXECUTE_OPERATION Execute;\r
+  \r
+  ///\r
+  /// Allows an SMBus 2.0 device(s) to be Address Resolution Protocol (ARP)\r
+  ///\r
   EFI_PEI_SMBUS_PPI_ARP_DEVICE        ArpDevice;\r
+  \r
+  ///\r
+  /// Allows a PEIM to retrieve the address that was allocated by the SMBus\r
+  /// host controller during enumeration/ARP.  \r
+  ///\r
   EFI_PEI_SMBUS_PPI_GET_ARP_MAP       GetArpMap;\r
+  \r
+  ///\r
+  /// Allows a driver to register for a callback to the SMBus host\r
+  /// controller driver when the bus issues a notification to the bus controller PEIM.  \r
+  ///\r
   EFI_PEI_SMBUS_PPI_NOTIFY            Notify;\r
 };\r
 \r