Refine code for MdePkg/Include/Ppi according to code review comments.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5951 6f19259b-4bc3-4df7-8a09-765794883524

1 files changed, 20 insertions, 39 deletions

diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable2.h b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
index 49a455017e..329266a879 100644
--- a/MdePkg/Include/Ppi/ReadOnlyVariable2.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable2.h
@@ -34,32 +34,21 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI  EFI_PEI_READ_ONLY_VARIABLE2_PPI
   the error EFI_BUFFER_TOO_SMALL is returned and DataSize is set to the

   required buffer size to obtain the data.

 

-  @param  This            A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.

-

-  @param  VariableName    A pointer to a null-terminated string that is the variable's name.

-

-  @param  VendorGuid      A pointer to an EFI_GUID that is the variable's GUID. The combination of

-                          VariableGuid and VariableName must be unique.

-

-  @param  Attributes      If non-NULL, on return, points to the variable's attributes. See "Related Definitons"

-                          below for possible attribute values.

-

-  @param  DataSize        On entry, points to the size in bytes of the Data buffer. On return, points to the size of

-                          the data returned in Data.

-

-  @param  Data            Points to the buffer which will hold the returned variable value.

-

-

-  @retval EFI_SUCCESS           The function completed successfully.

-

-  @retval EFI_NOT_FOUND         The variable was not found.

+  @param  This                  A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.

+  @param  VariableName          A pointer to a null-terminated string that is the variable's name.

+  @param  VendorGuid            A pointer to an EFI_GUID that is the variable's GUID. The combination of

+                                VariableGuid and VariableName must be unique.

+  @param  Attributes            If non-NULL, on return, points to the variable's attributes.

+  @param  DataSize              On entry, points to the size in bytes of the Data buffer.

+                                On return, points to the size of the data returned in Data.

+  @param  Data                  Points to the buffer which will hold the returned variable value.

 

+  @retval EFI_SUCCESS           The variable was read successfully.

+  @retval EFI_NOT_FOUND         The variable could not be found.

   @retval EFI_BUFFER_TOO_SMALL  The DataSize is too small for the resulting data. 

                                 DataSize is updated with the size required for 

                                 the specified variable.

-

   @retval EFI_INVALID_PARAMETER VariableName, VariableGuid, DataSize or Data is NULL.

-

   @retval EFI_DEVICE_ERROR      The variable could not be retrieved because of a device error.

 

 **/

@@ -88,25 +77,19 @@ EFI_STATUS
   @param  This              A pointer to this instance of the EFI_PEI_READ_ONLY_VARIABLE2_PPI.

 

   @param  VariableNameSize  On entry, points to the size of the buffer pointed to by VariableName.

-

   @param  VariableName      On entry, a pointer to a null-terminated string that is the variable's name.

                             On return, points to the next variable's null-terminated name string.

 

   @param  VendorGuid        On entry, a pointer to an UEFI _GUID that is the variable's GUID. 

                             On return, a pointer to the next variable's GUID.

 

-

   @retval EFI_SUCCESS           The variable was read successfully.

-

   @retval EFI_NOT_FOUND         The variable could not be found.

-

   @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the resulting

                                 data. VariableNameSize is updated with the size

                                 required for the specified variable.

-

   @retval EFI_INVALID_PARAMETER VariableName, VariableGuid or

                                 VariableNameSize is NULL.

-

   @retval EFI_DEVICE_ERROR      The variable could not be retrieved because of a device error.

 

 **/

@@ -119,20 +102,18 @@ EFI_STATUS
   IN OUT    EFI_GUID                        *VariableGuid

   );

 

-/**

-  @par Ppi Description:

-  This PPI provides a lightweight, read-only variant of the full EFI 

-  variable services. 

-

-  @param GetVariable

-  A service to ascertain a given variable name.

-

-  @param GetNextVariableName

-  A service to ascertain a variable based upon a given, known variable

-

-**/

+///

+/// This PPI provides a lightweight, read-only variant of the full EFI 

+/// variable services. 

+///

 struct _EFI_PEI_READ_ONLY_VARIABLE2_PPI {

+  ///

+  /// A service to read the value of a particular variable using its name.

+  ///

   EFI_PEI_GET_VARIABLE2       GetVariable;

+  ///

+  /// Find the next variable name in the variable store.

+  ///

   EFI_PEI_NEXT_VARIABLE_NAME2 NextVariableName;

 };