Synchronize function comments from library class to library instance.

[mirror_edk2.git] / MdePkg / Library / PeiExtractGuidedSectionLib / PeiExtractGuidedSectionLib.c

diff --git a/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c
index 1633f1b8f40e11f83d93389f662ab2943973313c..fd2a69627a6345b4ec2e3045cb8a7e4be47a95b2 100644 (file)
--- a/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c
+++ b/MdePkg/Library/PeiExtractGuidedSectionLib/PeiExtractGuidedSectionLib.c
@@ -36,11 +36,10 @@ typedef struct {
 \r
   @param[in, out]  InfoPointer   Pointer to pei handler info structure.\r
 \r
-  @retval  RETURN_SUCCESS            Build Guid hob for the global memory space to store guid and funciton tables.\r
+  @retval  RETURN_SUCCESS            Build Guid hob for the global memory space to store guid and function tables.\r
   @retval  RETURN_OUT_OF_RESOURCES   No enough memory to allocated.\r
 **/\r
 RETURN_STATUS\r
-EFIAPI\r
 PeiGetExtractGuidedSectionHandlerInfo (\r
   IN OUT PEI_EXTRACT_GUIDED_SECTION_HANDLER_INFO **InfoPointer\r
   )\r
@@ -127,7 +126,7 @@ PeiGetExtractGuidedSectionHandlerInfo (
   and caller must treat this array of GUIDs as read-only data. \r
   If ExtractHandlerGuidTable is NULL, then ASSERT().\r
 \r
-  @param[out]  ExtractHandlerGuidTable  A pointer to the array of GUIDs tht have been registerd through\r
+  @param[out]  ExtractHandlerGuidTable  A pointer to the array of GUIDs that have been registered through\r
                                         ExtractGuidedSectionRegisterHandlers().\r
 \r
   @return the number of the supported extract guided Handler.\r
@@ -163,9 +162,10 @@ ExtractGuidedSectionGetGuidList (
   Registers handlers of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER and EXTRACT_GUIDED_SECTION_DECODE_HANDLER\r
   for a specific GUID section type.\r
 \r
-  Registers the handlers specified by GetInfoHandler and DecodeHandler witg the GUID specified by SectionGuid.\r
+  Registers the handlers specified by GetInfoHandler and DecodeHandler with the GUID specified by SectionGuid.\r
   If the GUID value specified by SectionGuid has already been registered, then return RETURN_ALREADY_STARTED.\r
   If there are not enough resources available to register the handlers  then RETURN_OUT_OF_RESOURCES is returned.\r
+  \r
   If SectionGuid is NULL, then ASSERT().\r
   If GetInfoHandler is NULL, then ASSERT().\r
   If DecodeHandler is NULL, then ASSERT().\r
@@ -179,7 +179,6 @@ ExtractGuidedSectionGetGuidList (
                              allocated output buffer. \r
 \r
   @retval  RETURN_SUCCESS           The handlers were registered.\r
-  @retval  RETURN_ALREADY_STARTED   Handlers have already been registered for the GUID specified by SectionGuid. \r
   @retval  RETURN_OUT_OF_RESOURCES  There are not enough resources available to register the handlers.\r
 \r
 **/\r
@@ -244,7 +243,7 @@ ExtractGuidedSectionRegisterHandlers (
 }\r
 \r
 /**\r
-  Retrives a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
+  Retrieves a GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
   EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
   The selected handler is used to retrieve and return the size of the decoded buffer and the size of an\r
   optional scratch buffer required to actually decode the data in a GUIDed section.\r
@@ -256,6 +255,7 @@ ExtractGuidedSectionRegisterHandlers (
   of type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers()\r
   is used to retrieve the OututBufferSize, ScratchSize, and Attributes values. The return status from the handler of\r
   type EXTRACT_GUIDED_SECTION_GET_INFO_HANDLER is returned.\r
+  \r
   If InputSection is NULL, then ASSERT().\r
   If OutputBufferSize is NULL, then ASSERT().\r
   If ScratchBufferSize is NULL, then ASSERT().\r
@@ -311,7 +311,7 @@ ExtractGuidedSectionGetInfo (
   for (Index = 0; Index < HandlerInfo->NumberOfExtractHandler; Index ++) {\r
     if (CompareGuid (HandlerInfo->ExtractHandlerGuidTable + Index, &(((EFI_GUID_DEFINED_SECTION *) InputSection)->SectionDefinitionGuid))) {\r
       //\r
-      // Call the match handler to getinfo for the input section data.\r
+      // Call the match handler to get info for the input section data.\r
       //\r
       return HandlerInfo->ExtractGetInfoHandlerTable [Index] (\r
                 InputSection,\r
@@ -329,7 +329,7 @@ ExtractGuidedSectionGetInfo (
 }\r
 \r
 /**\r
-  Retrives the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
+  Retrieves the GUID from a GUIDed section and uses that GUID to select an associated handler of type\r
   EXTRACT_GUIDED_SECTION_DECODE_HANDLER that was registered with ExtractGuidedSectionRegisterHandlers().\r
   The selected handler is used to decode the data in a GUIDed section and return the result in a caller\r
   allocated output buffer.\r
@@ -343,7 +343,8 @@ ExtractGuidedSectionGetInfo (
   decode operation is returned in AuthenticationStatus.  If the decoded buffer is identical to the data in InputSection,\r
   then OutputBuffer is set to point at the data in InputSection.  Otherwise, the decoded data will be placed in caller\r
   allocated buffer specified by OutputBuffer.    This function is responsible for computing the  EFI_AUTH_STATUS_PLATFORM_OVERRIDE\r
-  bit of in AuthenticationStatus.  The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned.  \r
+  bit of in AuthenticationStatus.  The return status from the handler of type EXTRACT_GUIDED_SECTION_DECODE_HANDLER is returned. \r
+   \r
   If InputSection is NULL, then ASSERT().\r
   If OutputBuffer is NULL, then ASSERT().\r
   If ScratchBuffer is NULL and this decode operation requires a scratch buffer, then ASSERT().\r