Update MdePkg/Include/Ppi according to code review comments.

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

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
index 1a7487bce06007ec2172bc66e0ff4bc69217c089..338b60ace1b351b6cf387b2ac7cbe368f609e1b7 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -26,39 +26,40 @@
 \r
 typedef struct _EFI_PEI_FIRMWARE_VOLUME_INFO_PPI  EFI_PEI_FIRMWARE_VOLUME_INFO_PPI;\r
 \r
-/**\r
-  @par Ppi Description:\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