1. cleanup to refine the doxgen comment.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index c93ad2664723965ad4b2596711c8056df61f2d77..d03c933c4d68202ed01711d2cea79806814b790b 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -1,5 +1,6 @@
 /** @file\r
-  This file declares Read-only Variable Service PPI\r
+  This file declares Read-only Variable Service PPI, which is required PPI by framework spec.\r
+\r
   These services provide a lightweight, read-only variant of the full EFI variable services. The\r
   reason that these services are read-only is to reduce the complexity of flash management. Also,\r
   some implementation of the PEI may use the same physical flash part for variable and PEIM\r
@@ -15,12 +16,6 @@
   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:  ReadOnlyVariable.h\r
-\r
-  @par Revision Reference:\r
-  This PPI is defined in PEI CIS\r
-  Version 0.91.\r
-\r
 **/\r
 \r
 #ifndef __PEI_READ_ONLY_VARIABLE_PPI_H__\r
@@ -41,7 +36,6 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 #define EFI_VARIABLE_NON_VOLATILE       0x00000001\r
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
 #define EFI_VARIABLE_RUNTIME_ACCESS     0x00000004\r
-#define EFI_VARIABLE_READ_ONLY          0x00000008\r
 \r
 /**\r
   Get Variable value by Name and GUID pair\r
@@ -105,10 +99,10 @@ EFI_STATUS
   IN OUT EFI_GUID                 *VendorGuid\r
   );\r
 \r
-/**\r
-  This PPI provides a lightweight, read-only variant of the full EFI\r
-  variable services.\r
-**/\r
+///\r
+/// This PPI provides a lightweight, read-only variant of the full EFI\r
+/// variable services.  \r
+///\r
 struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {\r
   EFI_PEI_GET_VARIABLE            PeiGetVariable;         ///< A service to ascertain a given variable name.\r
   EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r