Fixed typos per the PI Spec 1.2 Errata B.

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

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
index 7f8698d07788a00c2bc4c48f91faca281a3baab8..23872aa2fd4056ba312c26b15413c06eeabc4b8f 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -1,8 +1,8 @@
-/* @file\r
+/** @file\r
   This file provides location and format of a firmware volume.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -10,11 +10,8 @@
   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:  FirmwareVolumeInfo.h\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,44 +23,46 @@
 #define EFI_PEI_FIRMWARE_VOLUME_INFO_PPI_GUID \\r
 { 0x49edb1c1, 0xbf21, 0x4761, { 0xbb, 0x12, 0xeb, 0x0, 0x31, 0xaa, 0xbb, 0x39 } }\r
 \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
+typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\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
-       EFI_GUID        FvFormat;\r
-       VOID                    *FvInfo;\r
-       UINT32          FvInfoSize;\r
-       EFI_GUID        *ParentFvName;\r
-       EFI_GUID        *ParentFileName;\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
-extern EFI_GUID        gEfiPeiFirmwareVolumeInfoPpiGuid;\r
+extern EFI_GUID gEfiPeiFirmwareVolumeInfoPpiGuid;\r
 \r
 #endif\r
 \r