Second set of changes based on a review of the code comments in the Include directory...

[mirror_edk2.git] / MdePkg / Include / Library / DxeServicesLib.h

diff --git a/MdePkg/Include/Library/DxeServicesLib.h b/MdePkg/Include/Library/DxeServicesLib.h
index aea99dec3af30aa1f16ae4e8dbf653c030d18bf7..23a8bed3f26c145993803f46bc358140edb0de83 100644 (file)
--- a/MdePkg/Include/Library/DxeServicesLib.h
+++ b/MdePkg/Include/Library/DxeServicesLib.h
@@ -13,14 +13,17 @@
 \r
 **/\r
 \r
-#ifndef __DXE_SERVICES_LIB_H__\r
-#define __DXE_SERVICES_LIB_H__\r
+#ifndef __PI_LIB_H__\r
+#define __PI_LIB_H__\r
+\r
+#include <Pi/PiFirmwareFile.h>\r
+\r
 \r
 /**\r
-  Searches all the availables firmware volumes and returns the first matching FFS section. \r
+  Searches all the available firmware volumes and returns the first matching FFS section. \r
 \r
   This function searches all the firmware volumes for FFS files with an FFS filename specified by NameGuid.  \r
-  The order that the firmware volumes is searched is not deterministic. For each FFS file found a search \r
+  The order in which the firmware volumes are searched is not deterministic. For each FFS file found, a search \r
   is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance instances \r
   of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer. \r
   Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. \r
@@ -42,7 +45,7 @@
   @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
   @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               Is it the caller's responsibility to free this buffer using FreePool().\r
+                               It is the caller's responsibility to free this buffer using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
   @retval  EFI_SUCCESS          The specified FFS section was returned.\r
@@ -66,7 +69,7 @@ GetSectionFromAnyFv  (
   Searches the firmware volume that the currently executing module was loaded from and returns the first matching FFS section. \r
 \r
   This function searches the firmware volume that the currently executing module was loaded \r
-  from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found a search \r
+  from for an FFS file with an FFS filename specified by NameGuid. If the FFS file is found, a search \r
   is made for FFS sections of type SectionType. If the FFS file contains at least SectionInstance \r
   instances of the FFS section specified by SectionType, then the SectionInstance instance is returned in Buffer.\r
   Buffer is allocated using AllocatePool(), and the size of the allocated buffer is returned in Size. \r
@@ -88,7 +91,7 @@ GetSectionFromAnyFv  (
   @param  SectionType          Indicates the FFS section type to search for within the FFS file specified by NameGuid.\r
   @param  SectionInstance      Indicates which section instance within the FFS file specified by NameGuid to retrieve.\r
   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               Is it the caller's responsibility to free this buffer using FreePool().\r
+                               It is the caller's responsibility to free this buffer using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
 \r
@@ -134,7 +137,7 @@ GetSectionFromFv (
   @param  SectionInstance      Indicates which section instance to retrieve within the FFS file \r
                                that the currently executing module was loaded from.\r
   @param  Buffer               On output, a pointer to a callee allocated buffer containing the FFS file section that was found.  \r
-                               Is it the caller's responsibility to free this buffer using FreePool().\r
+                               It is the caller's responsibility to free this buffer using FreePool().\r
   @param  Size                 On output, a pointer to the size, in bytes, of Buffer.\r
 \r
   @retval  EFI_SUCCESS          The specified FFS section was returned.\r