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

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

diff --git a/MdePkg/Include/Ppi/SectionExtraction.h b/MdePkg/Include/Ppi/SectionExtraction.h
index afa473d9ef5e7d80231b82d7a4c0cf0bfdf90d89..fb95f6065a7bcbe37865e6724074ee2af4b266dc 100644 (file)
--- a/MdePkg/Include/Ppi/SectionExtraction.h
+++ b/MdePkg/Include/Ppi/SectionExtraction.h
@@ -41,50 +41,40 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
   It will retrieve both encapsulation sections and leaf sections in their entirety,\r
   exclusive of the section header.\r
 \r
-  @param  PeiServices Pointer to the PEI Services Table.\r
-  \r
-  @param  This Indicates the calling context\r
-  \r
-  @param  SectionType Pointer to an EFI_SECTION_TYPE. If SectionType == NULL, \r
-  the contents of the entire section are returned in Buffer. If SectionType \r
-  is not NULL, only the requested section is returned.\r
-  \r
-  @param  SectionDefinitionGuid Pointer to an EFI_GUID.\r
-  If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid \r
-  indicates for which section GUID to search.\r
-  If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid \r
-  is unused and is ignored.\r
-  \r
-  @param  SectionInstance If SectionType is not NULL, indicates which \r
-  instance of the requested section type to return.\r
-  \r
-  @param  Buffer Pointer to a pointer to a buffer in which the section \r
-  contents are returned.\r
-  \r
-  @param  BufferSize A pointer to a caller-allocated UINT32.On input, *BufferSize \r
-  indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
-  *BufferSize contains the number of bytes required to read the section.\r
-  \r
-  @param  AuthenticationStatus A pointer to a caller-allocated UINT32 in \r
-  which any metadata from encapsulating GUID-defined sections is returned.\r
-\r
-  @retval EFI_SUCCESS The section was successfully processed and the section \r
-  contents were returned in Buffer.\r
-  \r
-  @retval EFI_PROTOCOL_ERROR A GUID-defined section was encountered in \r
-  the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but \r
-  there was no corresponding GUIDed Section Extraction Protocol in the \r
-  handle database.*Buffer is unmodified.\r
-  \r
-  @retval EFI_NOT_FOUND The requested section does not exist.*Buffer is unmodified.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES The system has insufficient resources to process the request.\r
-  \r
+  @param  PeiServices    Pointer to the PEI Services Table.\r
+  @param  This           Indicates the calling context\r
+  @param  SectionType    Pointer to an EFI_SECTION_TYPE. If SectionType == NULL,\r
+                         the contents of the entire section are returned in Buffer. If SectionType\r
+                         is not NULL, only the requested section is returned.\r
+  @param  SectionDefinitionGuid \r
+                         Pointer to an EFI_GUID.\r
+                         If SectionType == EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+                         indicates for which section GUID to search.\r
+                         If SectionType != EFI_SECTION_GUID_DEFINED, SectionDefinitionGuid\r
+                         is unused and is ignored.\r
+  @param  SectionInstance If SectionType is not NULL, indicates which\r
+                         instance of the requested section type to return.\r
+  @param  Buffer         Pointer to a pointer to a buffer in which the section\r
+                         contents are returned.\r
+  @param  BufferSize     A pointer to a caller-allocated UINT32.On input, *BufferSize\r
+                         indicates the size in bytes of the memory region pointed to by Buffer.On output,\r
+                         *BufferSize contains the number of bytes required to read the section.\r
+  @param  AuthenticationStatus \r
+                         A pointer to a caller-allocated UINT32 in\r
+                         which any metadata from encapsulating GUID-defined sections is returned.\r
+\r
+  @retval EFI_SUCCESS           The section was successfully processed and the section\r
+                                contents were returned in Buffer.\r
+  @retval EFI_PROTOCOL_ERROR    A GUID-defined section was encountered in\r
+                                the file with its EFI_GUIDED_SECTION_PROCESSING_REQUIRED bit set, but\r
+                                there was no corresponding GUIDed Section Extraction Protocol in the\r
+                                handle database.*Buffer is unmodified.\r
+  @retval EFI_NOT_FOUND         The requested section does not exist.*Buffer is unmodified.\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process the request.\r
   @retval EFI_INVALID_PARAMETER The SectionStreamHandle does not exist.\r
-  \r
-  @retval EFI_WARN_TOO_SMALL The size of the input buffer is insufficient to \r
-  contain the requested section.  The input buffer is filled and contents are\r
-  section contents are truncated.\r
+  @retval EFI_WARN_TOO_SMALL    The size of the input buffer is insufficient to\r
+                                contain the requested section. The input buffer is filled and contents are\r
+                                section contents are truncated.\r
 \r
 **/\r
 typedef\r