Remove BugBug in comments and adjust function header according to code style doc.

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

diff --git a/MdePkg/Include/Ppi/ReadOnlyVariable.h b/MdePkg/Include/Ppi/ReadOnlyVariable.h
index 3ea3c77535f658f573e24b5513cf5462aa2105c1..e730ce8493f42c635104758fa3aa1e618a0fe87c 100644 (file)
--- a/MdePkg/Include/Ppi/ReadOnlyVariable.h
+++ b/MdePkg/Include/Ppi/ReadOnlyVariable.h
@@ -39,29 +39,20 @@ typedef struct _EFI_PEI_READ_ONLY_VARIABLE_PPI  EFI_PEI_READ_ONLY_VARIABLE_PPI;
 /**\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
-  \r
-  @param  VariableName A NULL-terminated Unicode string that is the name of the vendor¡¯s variable. \r
-  \r
-  @param  VendorGuid A unique identifier for the vendor.\r
-  \r
-  @param  Attributes If not NULL, a pointer to the memory location to return \r
-  the attributes bitmask for the variable.\r
-  \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
-  \r
-  @param  Data The buffer to return the contents of the variable.\r
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
-  @retval EFI_NOT_FOUND The variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The BufferSize is too small for the result.\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
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The BufferSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR The variable could not be retrieved due to a hardware error.\r
+  @retval EFI_DEVICE_ERROR      The variable could not be retrieved due to a hardware error.\r
 \r
 **/\r
 typedef\r
@@ -82,27 +73,20 @@ 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
-  \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
-  \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
-  \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
-\r
-  @retval EFI_SUCCESS The function completed successfully. \r
-  \r
-  @retval EFI_NOT_FOUND The next variable was not found.\r
-  \r
-  @retval EFI_BUFFER_TOO_SMALL The VariableNameSize is too small for the result.\r
-  \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
+\r
+  @retval EFI_SUCCESS           The function completed successfully.\r
+  @retval EFI_NOT_FOUND         The next variable was not found.\r
+  @retval EFI_BUFFER_TOO_SMALL  The VariableNameSize is too small for the result.\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an invalid value.\r
-  \r
-  @retval EFI_DEVICE_ERROR The variable name could not be retrieved due to a hardware error.\r
+  @retval EFI_DEVICE_ERROR      The variable name could not be retrieved due to a hardware error.\r
 \r
 **/\r
 typedef\r