]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/SectionExtraction.h
Remove BugBug in comments and adjust function header according to code style doc.
[mirror_edk2.git] / MdePkg / Include / Protocol / SectionExtraction.h
index 9200f8a444ebb7ca108fedc8a1bc404d40830fc0..adc03f598541e884aab94b714b8dd195c23e102c 100644 (file)
@@ -41,17 +41,17 @@ typedef struct _EFI_SECTION_EXTRACTION_PROTOCOL EFI_SECTION_EXTRACTION_PROTOCOL;
 /**\r
   Creates and returns a new section stream handle to represent the new section stream.\r
 \r
-  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.  \r
-  @param  SectionStreamLength   Size in bytes of the section stream.  \r
-  @param  SectionStream         Buffer containing the new section stream.  \r
-  @param  SectionStreamHandle   A pointer to a caller-allocated UINTN that, \r
+  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
+  @param  SectionStreamLength   Size in bytes of the section stream.\r
+  @param  SectionStream         Buffer containing the new section stream.\r
+  @param  SectionStreamHandle   A pointer to a caller-allocated UINTN that,\r
                                 on output, contains the new section stream handle.\r
 \r
-  @retval EFI_SUCCESS           The SectionStream  was successfully processed and \r
-                                the section stream handle was returned.  \r
-  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to \r
-                                process the request.  \r
-  @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value \r
+  @retval EFI_SUCCESS           The SectionStream was successfully processed and\r
+                                the section stream handle was returned.\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to\r
+                                process the request.\r
+  @retval EFI_INVALID_PARAMETER The section stream may be corrupt or the value\r
                                 of SectionStreamLength may be incorrect.\r
 \r
 **/\r
@@ -67,36 +67,36 @@ EFI_STATUS
 /**\r
   Reads and returns a single section from a section stream.\r
 \r
-  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.                                \r
-  @param  SectionStreamHandle   Indicates from which section stream to read.                                \r
-  @param  SectionType           Pointer to an EFI_SECTION_TYPE.  \r
-  @param  SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType == \r
-                                EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID \r
-                                to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then \r
-                                SectionDefinitionGuid is unused and is ignored.  \r
-  @param  SectionInstance       Indicates which instance of the requested section \r
-                                type to return when SectionType is not NULL.  \r
+  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
+  @param  SectionStreamHandle   Indicates from which section stream to read.\r
+  @param  SectionType           Pointer to an EFI_SECTION_TYPE.\r
+  @param  SectionDefinitionGuid Pointer to an EFI_GUID.If SectionType ==\r
+                                EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid indicates what section GUID\r
+                                to search for.If SectionType !=EFI_SECTION_GUID_DEFINED, then\r
+                                SectionDefinitionGuid is unused and is ignored.\r
+  @param  SectionInstance       Indicates which instance of the requested section\r
+                                type to return when SectionType is not NULL.\r
   @param  SectionStreamHandle   A pointer to a caller-allocated UINTN that, on output,\r
-                                contains the new section stream handle.  \r
-  @param  Buffer                Pointer to a pointer to a buffer in which the section \r
-                                contents are returned.   \r
-  @param  BufferSize            Pointer to a caller-allocated UINTN.  \r
-  @param  AuthenticationStatus  Pointer to a caller-allocated UINT32 in \r
+                                contains the new section stream handle.\r
+  @param  Buffer                Pointer to a pointer to a buffer in which the section\r
+                                contents are returned.\r
+  @param  BufferSize            Pointer to a caller-allocated UINTN.\r
+  @param  AuthenticationStatus  Pointer to a caller-allocated UINT32 in\r
                                 which any meta-data from encapsulation GUID-defined sections is returned.\r
 \r
-  @retval EFI_SUCCESS           The SectionStream was successfully processed and \r
-                                the section contents were returned in Buffer.  \r
-  @retval EFI_PROTOCOL_ERROR    A GUID-defined section was encountered in \r
-                                the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, \r
-                                but there was no corresponding GUIDed Section Extraction Protocol in \r
-                                the handle database.  \r
-  @retval EFI_NOT_FOUND         An error was encountered when parsing the SectionStream, \r
+  @retval EFI_SUCCESS           The SectionStream was successfully processed and\r
+                                the section contents were returned in Buffer.\r
+  @retval EFI_PROTOCOL_ERROR    A GUID-defined section was encountered in\r
+                                the section stream with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set,\r
+                                but there was no corresponding GUIDed Section Extraction Protocol in\r
+                                the handle database.\r
+  @retval EFI_NOT_FOUND         An error was encountered when parsing the SectionStream,\r
                                 which indicates that the SectionStream is not correctly formatted.\r
-                                Or The requested section does not exist.  \r
-  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process \r
-                                the request.  \r
-  @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.  \r
-  @retval EFI_BUFFER_TOO_SMALL  The size of the input buffer is insufficient to \r
+                                Or The requested section does not exist.\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process\r
+                                the request.\r
+  @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
+  @retval EFI_BUFFER_TOO_SMALL  The size of the input buffer is insufficient to\r
                                 contain the requested section.\r
 \r
 **/\r
@@ -116,12 +116,10 @@ EFI_STATUS
 /**\r
   Deletes a section stream handle and returns all associated resources to the system.\r
 \r
-  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.  \r
+  @param  This                  Indicates the EFI_SECTION_EXTRACTION_PROTOCOL instance.\r
   @param  SectionStreamHandle   Indicates the section stream to close.\r
-  \r
-  @retval EFI_SUCCESS           The SectionStream was successfully processed and \r
+  @retval EFI_SUCCESS           The SectionStream was successfully processed and\r
                                 the section stream handle was returned.\r
-  \r
   @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
 \r
 **/\r