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

[mirror_edk2.git] / MdePkg / Include / Protocol / FirmwareVolume.h

diff --git a/MdePkg/Include/Protocol/FirmwareVolume.h b/MdePkg/Include/Protocol/FirmwareVolume.h
index 7f86dbb8536eddab0c2d61b9b09a65924b1c1146..310ea831389b1dddc10d9a8bbc9bfae0f0c4c3ac 100644 (file)
--- a/MdePkg/Include/Protocol/FirmwareVolume.h
+++ b/MdePkg/Include/Protocol/FirmwareVolume.h
@@ -82,8 +82,8 @@ typedef UINT64  EFI_FV_ATTRIBUTES;
   Retrieves attributes, insures positive polarity of attribute bits, returns\r
   resulting attributes in output parameter\r
 \r
-  @param  This Calling context\r
-  @param  Attributes output buffer which contains attributes\r
+  @param  This                  Calling context\r
+  @param  Attributes            output buffer which contains attributes\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_SUCCESS\r
@@ -99,8 +99,8 @@ EFI_STATUS
 /**\r
   Sets volume attributes\r
 \r
-  @param  This Calling context\r
-  @param  Attributes Buffer which contains attributes\r
+  @param  This                  Calling context\r
+  @param  Attributes            Buffer which contains attributes\r
 \r
   @retval EFI_INVALID_PARAMETER\r
   @retval EFI_DEVICE_ERROR\r
@@ -121,24 +121,23 @@ typedef UINT32  EFI_FV_FILE_ATTRIBUTES;
 /**\r
   Read the requested file (NameGuid) and returns data in Buffer.\r
 \r
-  @param  This Calling context\r
-  @param  NameGuid Filename identifying which file to read\r
-  @param  Buffer Pointer to pointer to buffer in which contents of file are returned.\r
-  <br>\r
-  If Buffer is NULL, only type, attributes, and size are returned as\r
-  there is no output buffer.\r
-  <br>\r
-  If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
-  from BS pool by ReadFile\r
-  <br>\r
-  If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
-  allocated by the caller and is being passed in.\r
-  \r
-  @param  BufferSize Indicates the buffer size passed in, and on output the size\r
-  required to complete the read\r
-  @param  FoundType Indicates the type of the file who's data is returned\r
-  @param  FileAttributes Indicates the attributes of the file who's data is resturned\r
-  @param  AuthenticationStatus Indicates the authentication status of the data\r
+  @param  This                  Calling context\r
+  @param  NameGuid              Filename identifying which file to read\r
+  @param  Buffer                Pointer to pointer to buffer in which contents of file are returned.\r
+                                <br>\r
+                                If Buffer is NULL, only type, attributes, and size are returned as\r
+                                there is no output buffer.\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
+                                from BS pool by ReadFile\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
+                                allocated by the caller and is being passed in.\r
+  @param  BufferSize            Indicates the buffer size passed in, and on output the size\r
+                                required to complete the read\r
+  @param  FoundType             Indicates the type of the file who's data is returned\r
+  @param  FileAttributes        Indicates the attributes of the file who's data is resturned\r
+  @param  AuthenticationStatus  Indicates the authentication status of the data\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_WARN_BUFFER_TOO_SMALL\r
@@ -162,24 +161,23 @@ EFI_STATUS
 /**\r
   Read the requested section from the specified file and returns data in Buffer.\r
 \r
-  @param  This Calling context\r
-  @param  NameGuid Filename identifying the file from which to read\r
-  @param  SectionType Indicates what section type to retrieve\r
-  @param  SectionInstance Indicates which instance of SectionType to retrieve\r
-  @param  Buffer Pointer to pointer to buffer in which contents of file are returned.\r
-  <br>\r
-  If Buffer is NULL, only type, attributes, and size are returned as\r
-  there is no output buffer.\r
-  <br>\r
-  If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
-  from BS pool by ReadFile\r
-  <br>\r
-  If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
-  allocated by the caller and is being passed in.\r
-  \r
-  @param  BufferSize Indicates the buffer size passed in, and on output the size\r
-  required to complete the read\r
-  @param  AuthenticationStatus Indicates the authentication status of the data\r
+  @param  This                  Calling context\r
+  @param  NameGuid              Filename identifying the file from which to read\r
+  @param  SectionType           Indicates what section type to retrieve\r
+  @param  SectionInstance       Indicates which instance of SectionType to retrieve\r
+  @param  Buffer                Pointer to pointer to buffer in which contents of file are returned.\r
+                                <br>\r
+                                If Buffer is NULL, only type, attributes, and size are returned as\r
+                                there is no output buffer.\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer == NULL, the output buffer is allocated\r
+                                from BS pool by ReadFile\r
+                                <br>\r
+                                If Buffer != NULL and *Buffer != NULL, the output buffer has been\r
+                                allocated by the caller and is being passed in.\r
+  @param  BufferSize            Indicates the buffer size passed in, and on output the size\r
+                                required to complete the read\r
+  @param  AuthenticationStatus  Indicates the authentication status of the data\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_WARN_BUFFER_TOO_SMALL\r
@@ -217,13 +215,13 @@ typedef struct {
 /**\r
   Write the supplied file (NameGuid) to the FV.\r
 \r
-  @param  This Calling context\r
-  @param  NumberOfFiles Indicates the number of file records pointed to by FileData\r
-  @param  WritePolicy Indicates the level of reliability of the write with respect to\r
-  things like power failure events.\r
-  @param  FileData A pointer to an array of EFI_FV_WRITE_FILE_DATA structures.  Each\r
-  element in the array indicates a file to write, and there are\r
-  NumberOfFiles elements in the input array.\r
+  @param  This                  Calling context\r
+  @param  NumberOfFiles         Indicates the number of file records pointed to by FileData\r
+  @param  WritePolicy           Indicates the level of reliability of the write with respect to\r
+                                things like power failure events.\r
+  @param  FileData              A pointer to an array of EFI_FV_WRITE_FILE_DATA structures. Each\r
+                                element in the array indicates a file to write, and there are\r
+                                NumberOfFiles elements in the input array.\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_OUT_OF_RESOURCES\r
@@ -245,14 +243,14 @@ EFI_STATUS
 /**\r
   Given the input key, search for the next matching file in the volume.\r
 \r
-  @param  This Calling context\r
-  @param  Key Pointer to a caller allocated buffer that contains an implementation\r
-  specific key that is used to track where to begin searching on\r
-  successive calls.\r
-  @param  FileType Indicates the file type to filter for\r
-  @param  NameGuid Guid filename of the file found\r
-  @param  Attributes Attributes of the file found\r
-  @param  Size Size in bytes of the file found\r
+  @param  This                  Calling context\r
+  @param  Key                   Pointer to a caller allocated buffer that contains an implementation\r
+                                specific key that is used to track where to begin searching on\r
+                                successive calls.\r
+  @param  FileType              Indicates the file type to filter for\r
+  @param  NameGuid              Guid filename of the file found\r
+  @param  Attributes            Attributes of the file found\r
+  @param  Size                  Size in bytes of the file found\r
 \r
   @retval EFI_SUCCESS\r
   @retval EFI_NOT_FOUND\r