Code Scrub for Protocol and Ppi Definition

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

diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
index 796f8cede99332e9142c954cccd34d4a5b77aabe..27f3e180738808ee15dd913b1dac9f8c44d4ec5f 100644 (file)
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -1,10 +1,10 @@
-/* @file\r
+/** @file\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 Extraction PPI \r
-  to extract the section stream contained therein.. \r
+  to extract the section stream contained therein. \r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -13,8 +13,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
 \r
-  Module Name:  GuidedSectionExtraction.h\r
-\r
   @par Revision Reference:\r
   This PPI is defined in PI Version 1.00.\r
 \r
@@ -39,15 +37,11 @@
 \r
 typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI;\r
 \r
-//\r
-// Bit values for AuthenticationStatus\r
-//\r
-#define EFI_AUTH_STATUS_PLATFORM_OVERRIDE   0x01\r
-#define EFI_AUTH_STATUS_IMAGE_SIGNED        0x02\r
-#define EFI_AUTH_STATUS_NOT_TESTED          0x04\r
-#define EFI_AUTH_STATUS_TEST_FAILED         0x08\r
 \r
 /**\r
+  Processes the input section and returns the data contained therein \r
+  along with the authentication status.\r
+\r
   The ExtractSection() function processes the input section and\r
   returns a pointer to the section contents. If the section being\r
   extracted does not require processing (if the section\r
@@ -94,7 +88,7 @@ typedef struct _EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI   EFI_PEI_GUIDED_SECTION_E
   @retval EFI_OUT_OF_RESOURCES  The system has insufficient\r
                                 resources to process the request.\r
   \r
-  @reteval EFI_INVALID_PARAMETER The GUID in InputSection does\r
+  @retval EFI_INVALID_PARAMETER The GUID in InputSection does\r
                                 not match this instance of the\r
                                 GUIDed Section Extraction PPI.\r
 **/\r
@@ -111,6 +105,7 @@ EFI_STATUS
 \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