Document the macro definitions for Variable Attributes.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
index c39e0e7e5d4bfea13502f94d46592feacf925b76..d99de161a73da905f9d6367ddb70d48b6fa0bb7b 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
+++ b/IntelFrameworkPkg/Include/Ppi/ReadOnlyVariable.h
@@ -31,30 +31,32 @@
 \r
 typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;\r
 \r
-//\r
-// Variable attributes\r
-//\r
+///\r
+/// Variable attributes\r
+///@{\r
 #define EFI_VARIABLE_NON_VOLATILE       0x00000001\r
 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002\r
 #define EFI_VARIABLE_RUNTIME_ACCESS     0x00000004\r
-       ///\r
+  /**\r
   /// Inconsistent with specification here: \r
-  /// In Framework Spec, PeiCis0.91, there is no this field defined.\r
-  /// Keeping this inconsistance is for backward compatibility.\r
-       /// \r
+  /// In Framework Spec, PeiCis0.91, neither the macro or its value is defined.\r
+  /// Keeping this inconsistancy for backward compatibility.\r
+  **/ \r
 #define EFI_VARIABLE_READ_ONLY          0x00000008\r
+///@}\r
 \r
 /**\r
   Get Variable value by Name and GUID pair\r
 \r
-  @param  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  VariableName   A NULL-terminated Unicode string that is the name of the vendor's variable.\r
-  @param  VendorGuid     A unique identifier for the vendor.\r
-  @param  Attributes     If not NULL, a pointer to the memory location to return\r
-                         the attributes bitmask for the variable.\r
-  @param  DataSize       On input, the size in bytes of the return Data buffer.\r
-                         On output, the size of data returned in Data.\r
-  @param  Data           The buffer to return the contents of the variable.\r
+  @param[in]  PeiServices    An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param[in]  VariableName   A NULL-terminated Unicode string that is the name of the vendor's variable.\r
+  @param[in]  VendorGuid     A unique identifier for the vendor.\r
+  @param[out] Attributes     This OPTIONAL parameter may be either NULL or\r
+                             a pointer to the location in which to return\r
+                             the attributes bitmask for the variable.\r
+  @param[in,out]  DataSize   On input, the size in bytes of the return Data buffer.\r
+                             On output, the size of data returned in Data.\r
+  @param[out] Data           The buffer to return the contents of the variable.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The variable was not found.\r
@@ -66,12 +68,12 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_GET_VARIABLE)(\r
-  IN EFI_PEI_SERVICES             **PeiServices,\r
-  IN CHAR16                       *VariableName,\r
-  IN EFI_GUID                     *VendorGuid,\r
-  OUT UINT32                      *Attributes OPTIONAL,\r
-  IN OUT UINTN                    *DataSize,\r
-  OUT VOID                        *Data\r
+  IN     EFI_PEI_SERVICES   **PeiServices,\r
+  IN     CHAR16             *VariableName,\r
+  IN     EFI_GUID           *VendorGuid,\r
+     OUT UINT32             *Attributes OPTIONAL,\r
+  IN OUT UINTN              *DataSize,\r
+     OUT VOID               *Data\r
   );\r
 \r
 /**\r
@@ -81,14 +83,14 @@ EFI_STATUS
   and on output the interface returns the next variable name data.  When the\r
   entire variable list has been returned, the error EFI_NOT_FOUND is returned.\r
 \r
-  @param  PeiServices      An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
-  @param  VariableNameSize The size of the VariableName buffer.\r
-  @param  VariableName     On input, supplies the last VariableName that was\r
-                           returned by GetNextVariableName(). On output, returns the Null-terminated\r
-                           Unicode string of the current variable.\r
-  @param  VendorGuid       On input, supplies the last VendorGuid that was\r
-                           returned by GetNextVariableName(). On output, returns the VendorGuid\r
-                           of the current variable.\r
+  @param[in]  PeiServices       An indirect pointer to the PEI Services Table published by the PEI Foundation.\r
+  @param[in]  VariableNameSize  The size of the VariableName buffer.\r
+  @param[in]  VariableName      On input, supplies the last VariableName that was\r
+                                returned by GetNextVariableName(). On output, returns the Null-terminated\r
+                                Unicode string of the current variable.\r
+  @param[in]  VendorGuid        On input, supplies the last VendorGuid that was\r
+                                returned by GetNextVariableName(). On output, returns the VendorGuid\r
+                                of the current variable.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully.\r
   @retval EFI_NOT_FOUND         The next variable was not found.\r
@@ -122,4 +124,5 @@ struct _EFI_PEI_READ_ONLY_VARIABLE_PPI {
 \r
 extern EFI_GUID gEfiPeiReadOnlyVariablePpiGuid;\r
 \r
-#endif\r
+#endif /* __PEI_READ_ONLY_VARIABLE_PPI_H__ */\r
+\r