Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

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

diff --git a/MdePkg/Include/Library/ExtractGuidedSectionLib.h b/MdePkg/Include/Library/ExtractGuidedSectionLib.h
index 27faeeceb02bd4e303d15c3a7c9640884341d47f..72e979d0e3b953ec1df28e48d61e27c1dadfccc5 100644 (file)
--- a/MdePkg/Include/Library/ExtractGuidedSectionLib.h
+++ b/MdePkg/Include/Library/ExtractGuidedSectionLib.h
@@ -1,7 +1,8 @@
 /** @file\r
-  Extract Guided Section Library class\r
+  Extract Guided Section Library class defintions, \r
+  which can provide many handlers for the different guided section data.\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 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
@@ -10,13 +11,12 @@
   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
-  ExtractGuidedSectionLib.h\r
 **/\r
 #ifndef __EXTRACT_GUIDED_SECTION_H__\r
 #define __EXTRACT_GUIDED_SECTION_H__\r
 \r
 /**
-  Get information Handler for the input guided section data.\r
+  Get information for the input guided section data.\r
   It will ASSERT () if the pointer to OutputBufferSize is NULL.\r
   It will ASSERT () if the pointer to ScratchBufferSize is NULL.
   It will ASSERT () if the pointer to SectionAttribute is NULL.\r
@@ -27,7 +27,7 @@
   @param[out] SectionAttribute      The attribute of the input guided section.\r
 
   @retval  RETURN_SUCCESS           Get the required information successfully.\r
-  @retval  RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+  @retval  RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
 \r
 **/\r
 typedef\r
@@ -40,21 +40,21 @@ RETURN_STATUS
   );\r
 \r
 /**
-  Extract data Handler for one specific guided section.
+  Extract data and Auth from the specific guided section.
   It will ASSERT () if the pointer to OutputBuffer is NULL.\r
   It will ASSERT () if the pointer to AuthenticationStatus is NULL.\r
 \r
   @param[in]  InputSection  Buffer containing the input GUIDed section to be processed. \r
-  @param[out] OutputBuffer  OutputBuffer to point to the start of the section's contents.\r
+  @param[out] OutputBuffer  OutputBuffer directly points to the start of the section's contents,\r
                             if guided data is not prcessed. Otherwise,\r
-                            OutputBuffer to contain the output data, which is allocated by the caller.\r
+                            OutputBuffer contains the output data, which is allocated by the caller.\r
   @param[out] ScratchBuffer A pointer to a caller-allocated buffer for function internal use. \r
   @param[out] AuthenticationStatus \r
                             A pointer to a caller-allocated UINT32 that indicates the\r
                             authentication status of the output buffer. 
 
   @retval  RETURN_SUCCESS               Get the output data and AuthenticationStatus successfully.\r
-  @retval  RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+  @retval  RETURN_INVALID_PARAMETER     The input data is not the valid guided section.\r
 \r
 **/\r
 typedef\r
@@ -70,12 +70,12 @@ RETURN_STATUS
   Register Guided Section Extract and GetInfo Handler.\r
 \r
   @param[in]     SectionGuid    The guid matches this Extraction Handler.
-  @param[in]     GetInfoHandler Handler to get info from guided section.\r
+  @param[in]     GetInfoHandler Handler to get information from guided section.\r
   @param[in]     DecodeHandler  Handler to extract guided section.
 
   @retval  RETURN_SUCCESS           Register Guided Section Extract Handler successfully.
   @retval  RETURN_OUT_OF_RESOURCES  Resource is not enough to register new Handler. \r
-  @retval  RETURN_INVALID_PARAMETER Input pointer to Guid value is not valid.\r
+  @retval  RETURN_INVALID_PARAMETER Pointer to Guid value is not valid.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -88,18 +88,18 @@ ExtractGuidedSectionRegisterHandlers (
 \r
 /**
   Get the supported exract guided section Handler guid table, which is maintained\r
-  by library. The caller can directly get this guid table pointer \r
+  by library. The caller can directly get the guid table \r
   without responsibility to allocate or free this table buffer.  \r
   It will ASSERT () if ExtractHandlerGuidTable = NULL.\r
 \r
-  @param[in, out]  ExtractHandlerGuidTable   The extract Handler guid pointer list.
+  @param[out]  ExtractHandlerGuidTable   The extract Handler guid pointer list.
 \r
-  @retval  return the number of the supported extract guided Handler.
+  @return the number of the supported extract guided Handler.
 **/\r
 UINTN\r
 EFIAPI\r
 ExtractGuidedSectionGetGuidList (\r
-  IN OUT  GUID  **ExtractHandlerGuidTable\r
+  OUT  GUID  **ExtractHandlerGuidTable\r
   );\r
 \r
 /**
@@ -120,7 +120,7 @@ ExtractGuidedSectionGetGuidList (
 
   @retval  RETURN_SUCCESS           Get the required information successfully.\r
   @retval  RETURN_UNSUPPORTED       Guided section data is not supported.\r
-  @retval  RETURN_INVALID_PARAMETER The input data can't be parsed correctly.\r
+  @retval  RETURN_INVALID_PARAMETER The input data is not the valid guided section.\r
 \r
 **/\r
 RETURN_STATUS\r
@@ -154,7 +154,7 @@ ExtractGuidedSectionGetInfo (
 
   @retval  RETURN_SUCCESS           Get the output data and AuthenticationStatus successfully.\r
   @retval  RETURN_UNSUPPORTED       Guided section data is not supported to be decoded.\r
-  @retval  RETURN_INVALID_PARAMETER The input data can't be parsed correctly.
+  @retval  RETURN_INVALID_PARAMETER The input data is not the valid guided section.
 **/\r
 RETURN_STATUS\r
 EFIAPI\r