Refine comments.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index 6e6c0873a52764e49f656ecbe71d78d50347abb9..2a1b76ab264d3ae7ea77c619b7028548ece44d91 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -1,12 +1,13 @@
 /** @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
   storage; as such, a write command to certain technologies would alter the contents of the entire part,\r
   thus making the in situ PEIM execution not follow the required flow.\r
 \r
-  Copyright (c) 2006, Intel Corporation\r
+  Copyright (c) 2006 - 2009, 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
@@ -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,7 @@ 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
 /**\r
   Get Variable value by Name and GUID pair\r
@@ -64,7 +59,7 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_GET_VARIABLE) (\r
+(EFIAPI *EFI_PEI_GET_VARIABLE)(\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN CHAR16                       *VariableName,\r
   IN EFI_GUID                     *VendorGuid,\r
@@ -98,28 +93,20 @@ EFI_STATUS
 **/\r
 typedef\r
 EFI_STATUS\r
-(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME) (\r
+(EFIAPI *EFI_PEI_GET_NEXT_VARIABLE_NAME)(\r
   IN EFI_PEI_SERVICES             **PeiServices,\r
   IN OUT UINTN                    *VariableNameSize,\r
   IN OUT CHAR16                   *VariableName,\r
   IN OUT EFI_GUID                 *VendorGuid\r
   );\r
 \r
-/**\r
-  @par Ppi Description:\r
-  This PPI provides a lightweight, read-only variant of the full EFI\r
-  variable services.\r
-\r
-  @param GetVariable\r
-  A service to ascertain a given variable name.\r
-\r
-  @param GetNextVariableName\r
-  A service to ascertain a variable based upon a given, known variable\r
-\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;\r
-  EFI_PEI_GET_NEXT_VARIABLE_NAME  PeiGetNextVariableName;\r
+  EFI_PEI_GET_VARIABLE            GetVariable;         ///< A service to ascertain a given variable name.\r
+  EFI_PEI_GET_NEXT_VARIABLE_NAME  GetNextVariableName; ///< A service to ascertain a variable based upon a given, known variable\r
 };\r
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r