Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/BlockIo.h b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
index 014cca5c1f9680c5249bf38deb9e9ce5aedb709d..145139bf3383d18f9b17a137ecab8fc453ce04de 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/BlockIo.h
+++ b/IntelFrameworkPkg/Include/Ppi/BlockIo.h
@@ -1,7 +1,7 @@
 /** @file\r
   This file declares BlockIo PPI used to access block-oriented storage devices\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
@@ -132,24 +132,24 @@ EFI_STATUS
   OUT VOID                                     *Buffer\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
-  to access a block I/O device during PEI recovery boot mode.\r
-\r
-  @param GetNumberOfBlockDevices\r
-  Gets the number of block I/O devices that the specific block driver manages.\r
-\r
-  @param GetBlockDeviceMediaInfo\r
-  Gets the specified media information.\r
-\r
-  @param ReadBlocks\r
-  Reads the requested number of blocks from the specified block device.\r
-\r
-**/\r
+///\r
+///  EFI_PEI_RECOVERY_BLOCK_IO_PPI provides the services that are required\r
+///  to access a block I/O device during PEI recovery boot mode.\r
+///\r
 struct _EFI_PEI_RECOVERY_BLOCK_IO_PPI {\r
+  ///\r
+  /// Gets the number of block I/O devices that the specific block driver manages.\r
+  ///\r
   EFI_PEI_GET_NUMBER_BLOCK_DEVICES      GetNumberOfBlockDevices;\r
+  \r
+  ///\r
+  /// Gets the specified media information.\r
+  ///\r
   EFI_PEI_GET_DEVICE_MEDIA_INFORMATION  GetBlockDeviceMediaInfo;\r
+  \r
+  ///\r
+  /// Reads the requested number of blocks from the specified block device.\r
+  ///\r
   EFI_PEI_READ_BLOCKS                   ReadBlocks;\r
 };\r
 \r