correct a operation mistake

[mirror_edk2.git] / MdePkg / Include / Ppi / FirmwareVolumeInfo.h

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
index 8d44a31d4a55493fedee5372c8ded773eaaf47d1..0105a4c32e18ba68c2a4143d6fd3fbda931c24b3 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -1,7 +1,7 @@
-/* @file\r
+/** @file\r
   This file provides location and format of a firmware volume.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, 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
@@ -11,8 +11,7 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
   @par Revision Reference:\r
-  This PPI is defined in PI.\r
-  Version 1.00\r
+  This PPI is introduced in PI Version 1.0.\r
 \r
 **/\r
 \r
@@ -26,38 +25,40 @@
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
 \r
-/**\r
-  This PPI describes the location and format of a firmware volume. \r
-  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for \r
-  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is \r
-  the PI Firmware Volume format.\r
-\r
-  @param  FvFormat      Unique identifier of the format of the memory-mapped firmware volume.\r
-\r
-  @param  FvInfo        Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to\r
-                        process the volume. The format of this buffer is \r
-                        specific to the FvFormat. For memory-mapped firmware volumes, \r
-                        this typically points to the first byte of the firmware volume.\r
-\r
-  @param  FvInfoSize    Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
-                        this is typically the size of the firmware volume.\r
-\r
-  @param  ParentFvName  If the firmware volume originally came from a firmware file, \r
-                        then these point to the parent firmware volume\r
-                        name and firmware volume file. If it did not originally come\r
-                        from a firmware file, these should be NULL.\r
-\r
-  @param  ParentFileName  If the firmware volume originally came from a firmware file, \r
-                        then these point to the parent firmware volume\r
-                        name and firmware volume file. If it did not originally come\r
-                        from a firmware file, these should be NULL.\r
-\r
-**/\r
+///\r
+///  This PPI describes the location and format of a firmware volume. \r
+///  The FvFormat can be EFI_FIRMWARE_FILE_SYSTEM2_GUID or the GUID for \r
+///  a user-defined format. The  EFI_FIRMWARE_FILE_SYSTEM2_GUID is \r
+///  the PI Firmware Volume format.\r
+///\r
 struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI {\r
+  ///\r
+  /// Unique identifier of the format of the memory-mapped firmware volume.\r
+  ///\r
   EFI_GUID  FvFormat;\r
+  ///\r
+  /// Points to a buffer which allows the EFI_PEI_FIRMWARE_VOLUME_PPI to process\r
+  /// the volume. The format of this buffer is specific to the FvFormat.\r
+  /// For memory-mapped firmware volumes, this typically points to the first byte\r
+  /// of the firmware volume.\r
+  ///\r
   VOID      *FvInfo;\r
+  ///\r
+  /// Size of the data provided by FvInfo. For memory-mapped firmware volumes,\r
+  /// this is typically the size of the firmware volume.\r
+  ///\r
   UINT32    FvInfoSize;\r
+  ///\r
+  /// If the firmware volume originally came from a firmware file, then these\r
+  /// point to the parent firmware volume name and firmware volume file.\r
+  /// If it did not originally come from a firmware file, these should be NULL.\r
+  ///\r
   EFI_GUID  *ParentFvName;\r
+  ///\r
+  /// If the firmware volume originally came from a firmware file, then these\r
+  /// point to the parent firmware volume name and firmware volume file.\r
+  /// If it did not originally come from a firmware file, these should be NULL.\r
+  ///\r
   EFI_GUID  *ParentFileName;\r
 };\r
 \r