Code Clean for Driver PlatformDriOverrideDxe and PlatOverMngr application. And Clean...

[mirror_edk2.git] / MdeModulePkg / Include / Guid / SystemNvDataGuid.h

diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index 1f9e5e7987fd5df69dbc8a6e8f14adb80c2ee965..ab45166f0281633b36931d47c958371673e317fb 100644 (file)
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -1,6 +1,8 @@
 /** @file\r
-  This file defines NvDataHob GUIDs for System Non Volatile HOB entries \r
-  in the HOB list and NV system hob entry structure. \r
+  This file defines NvData Hob GUIDs for System Non Volatile HOB entries and the corresponding hob data structure.\r
+  NvData Hob is used to report the region of the system non volatile data \r
+  for the specific purpose, such as FTW region, Error log region.\r
+  \r
   It also defines NvDataFv GUID used as the signature of FTW working block header.\r
 \r
 Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
@@ -27,13 +29,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 /// Hob entry for NV data region\r
 ///\r
 typedef struct {\r
-  EFI_GUID                  SystemNvDataHobGuid; /// EFI_SYSTEM_NV_DATA_HOB_GUID\r
-  EFI_GUID                  SystemNvDataFvGuid;  /// Guid specifies the NvData Fv for the specific purpose, such as FTW, Error Log.\r
-  EFI_LBA                   StartLba;            /// The starting logical block index.\r
-  UINTN                     StartLbaOffset;      /// Offset into the starting block at which to the start of NvData region.\r
-  EFI_LBA                   EndLba;              /// The last logical block index.\r
-  UINTN                     EndLbaOffset;        /// Offset into the last block at which to the end of Nvdata region.\r
-  UINT32                    DataTypeSignature;   /// NvData type in the specified NV range.\r
+  EFI_GUID                  SystemNvDataHobGuid; ///> EFI_SYSTEM_NV_DATA_HOB_GUID\r
+  EFI_GUID                  SystemNvDataFvGuid;  ///> Guid specifies the NvData Fv for the specific purpose, such as FTW, Error Log.\r
+  EFI_LBA                   StartLba;            ///> The starting logical block index.\r
+  UINTN                     StartLbaOffset;      ///> Offset into the starting block at which to the start of NvData region.\r
+  EFI_LBA                   EndLba;              ///> The last logical block index.\r
+  UINTN                     EndLbaOffset;        ///> Offset into the last block at which to the end of Nvdata region.\r
+  UINT32                    DataTypeSignature;   ///> NvData type in the specified NV range.\r
 } NV_SYSTEM_DATA_GUID_TYPE;\r
 \r
 extern EFI_GUID gEfiSystemNvDataHobGuid;\r