Update MdePkg/Include/Ppi according to code review comments.

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

diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
index 27f3e180738808ee15dd913b1dac9f8c44d4ec5f..b25bbf32535adf3f80d153f40f0bdfe6c25f58b1 100644 (file)
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -51,75 +51,54 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_E
   section's contents. Otherwise, *Buffer must be allocated\r
   from PEI permanent memory.\r
 \r
-  @param This                   Indicates the\r
-                                EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI instance.\r
-                                Buffer containing the input GUIDed section to be\r
-                                processed. OutputBuffer OutputBuffer is\r
-                                allocated from PEI permanent memory and contains\r
-                                the new section stream.\r
+  @param This                   Indicates the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI\r
+                                instance.\r
+  @param InputSection           Buffer containing the input GUIDed section to be\r
+                                processed.\r
+  @param OutputBuffer           *OutputBuffer is allocated from PEI permanent memory\r
+                                and contains the new section stream.\r
+  @param OutputSize             A pointer to a caller-allocated UINTN in which\r
+                                the size of *OutputBuffer allocation is stored.\r
+                                If the function returns anything other than\r
+                                EFI_SUCCESS, the value of *OutputSize is undefined.\r
+  @param AuthenticationStatus   A pointer to a caller-allocated UINT32 that indicates\r
+                                the authentication status of the output buffer.\r
+                                If the input section's\r
+                                GuidedSectionHeader.Attributes field has the\r
+                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID bit as clear,\r
+                                *AuthenticationStatus must return zero. These bits\r
+                                reflect the status of the extraction operation.\r
+                                If the function returns anything other than EFI_SUCCESS,\r
+                                the value of *AuthenticationStatus is undefined.\r
   \r
-  @param OutputSize             A pointer to a caller-allocated\r
-                                UINTN in which the size of *OutputBuffer\r
-                                allocation is stored. If the function\r
-                                returns anything other than EFI_SUCCESS,\r
-                                the value of OutputSize is undefined.\r
-  \r
-  @param AuthenticationStatus   A pointer to a caller-allocated\r
-                                UINT32 that indicates the\r
-                                authentication status of the\r
-                                output buffer. If the input\r
-                                section's GuidedSectionHeader.\r
-                                Attributes field has the\r
-                                EFI_GUIDED_SECTION_AUTH_STATUS_VALID \r
-                                bit as clear,\r
-                                AuthenticationStatus must return\r
-                                zero. These bits reflect the\r
-                                status of the extraction\r
-                                operation. If the function\r
-                                returns anything other than\r
-                                EFI_SUCCESS, the value of\r
-                                AuthenticationStatus is\r
-                                undefined.\r
-  \r
-  @retval EFI_SUCCESS           The InputSection was\r
-                                successfully processed and the\r
+  @retval EFI_SUCCESS           The InputSection was successfully processed and the\r
                                 section contents were returned.\r
-  \r
-  @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
-                                resources to process the request.\r
-  \r
-  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
-                                not match this instance of the\r
+  @retval EFI_OUT_OF_RESOURCES  The system has insufficient resources to process the request.\r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does not match this instance of the\r
                                 GUIDed Section Extraction PPI.\r
 **/\r
 typedef\r
 EFI_STATUS\r
 (EFIAPI *EFI_PEI_EXTRACT_GUIDED_SECTION)(\r
-  IN CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
-  IN CONST  VOID                                  *InputSection,\r
-  OUT       VOID                                  **OutputBuffer,\r
-  OUT       UINTN                                 *OutputSize,\r
-  OUT       UINT32                                *AuthenticationStatus\r
+  IN  CONST  EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI *This,\r
+  IN  CONST  VOID                                  *InputSection,\r
+  OUT VOID                                         **OutputBuffer,\r
+  OUT UINTN                                        *OutputSize,\r
+  OUT UINT32                                       *AuthenticationStatus\r
 );\r
 \r
-\r
-\r
-/**\r
-  @par Ppi Description:\r
-  If a GUID-defined section is encountered when doing section extraction,\r
-  the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance\r
-  calls the appropriate instance of the GUIDed Section\r
-  Extraction PPI to extract the section stream contained\r
-  therein.\r
-  \r
-  \r
-  @param ExtractSection   Takes the GUIDed section as input and\r
-                          produces the section stream data. See\r
-                          the ExtractSection() function\r
-                          description.\r
-  \r
-**/\r
+///\r
+/// If a GUID-defined section is encountered when doing section extraction,\r
+/// the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance\r
+/// calls the appropriate instance of the GUIDed Section\r
+/// Extraction PPI to extract the section stream contained\r
+/// therein.\r
+///  \r
 struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI {\r
+  ///  \r
+  /// Takes the GUIDed section as input and\r
+  /// produces the section stream data.\r
+  ///\r
   EFI_PEI_EXTRACT_GUIDED_SECTION ExtractSection;\r
 };\r
 \r