Add more comments for IntelFramework's header files.

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

diff --git a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
index fb95f6065a7bcbe37865e6724074ee2af4b266dc..7d2ea98e0a05d739bcf75232d746c74998844ab9 100644 (file)
--- a/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
+++ b/IntelFrameworkPkg/Include/Ppi/SectionExtraction.h
@@ -1,14 +1,16 @@
 /** @file\r
   This file declares Section Extraction PPI.\r
+  This PPI supports encapsulating sections, such as GUIDed sections used to authenticate the file\r
+  encapsulation of other domain-specific wrapping.\r
 \r
-  Copyright (c) 2006, 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
-  http://opensource.org/licenses/bsd-license.php                                            \r
+  Copyright (c) 2006, 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
+  http://opensource.org/licenses/bsd-license.php\r
 \r
-  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
+  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:  SectionExtraction.h\r
 \r
@@ -21,6 +23,8 @@
 #ifndef __SECTION_EXTRACTION_PPI_H__\r
 #define __SECTION_EXTRACTION_PPI_H__\r
 \r
+#include <PiPei.h>\r
+\r
 #define EFI_PEI_SECTION_EXTRACTION_PPI_GUID \\r
   { \\r
     0x4F89E208, 0xE144, 0x4804, {0x9E, 0xC8, 0x0F, 0x89, 0x4F, 0x7E, 0x36, 0xD7 } \\r
@@ -46,7 +50,7 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
   @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
+  @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
@@ -59,7 +63,7 @@ typedef struct _EFI_PEI_SECTION_EXTRACTION_PPI EFI_PEI_SECTION_EXTRACTION_PPI;
   @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
+  @param  AuthenticationStatus\r
                          A pointer to a caller-allocated UINT32 in\r
                          which any metadata from encapsulating GUID-defined sections is returned.\r
 \r
@@ -92,7 +96,7 @@ EFI_STATUS
 \r
 /**\r
   @par Ppi Description:\r
-  This PPI supports encapsulating sections, such as GUIDed sections used to \r
+  This PPI supports encapsulating sections, such as GUIDed sections used to\r
   authenticate the file encapsulation of other domain-specific wrapping.\r
 \r
   @param GetSection\r