BaseTools: Source/C/Common: Fix doc block locations and convert to Doxygen

Move the documentation blocks from between the parameter list and function
body to above the function.

Convert all the documentation blocks to Doxygen format.

Signed-off-by: Rebecca Cran <rebecca@bsdio.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

1 files changed, 28 insertions, 54 deletions

diff --git a/BaseTools/Source/C/Common/ParseGuidedSectionTools.c b/BaseTools/Source/C/Common/ParseGuidedSectionTools.c
index a34581ecb6..e1e9a97e7b 100644
--- a/BaseTools/Source/C/Common/ParseGuidedSectionTools.c
+++ b/BaseTools/Source/C/Common/ParseGuidedSectionTools.c
@@ -33,30 +33,22 @@ typedef struct _GUID_SEC_TOOL_ENTRY {
 // Function Implementation

 //

 

-EFI_HANDLE

-ParseGuidedSectionToolsFile (

-  IN CHAR8    *InputFile

-  )

-/*++

-

-Routine Description:

-

+/**

   This function parses the tools_def.txt file.  It returns a

   EFI_HANDLE object which can be used for the other library

   functions and should be passed to FreeParsedGuidedSectionToolsHandle

   to free resources when the tools_def.txt information is no

   longer needed.

 

-Arguments:

+  @param InputFile     Path name of file to read

 

-  InputFile     Path name of file to read

-

-Returns:

-

-  NULL if error parsing

-  A non-NULL EFI_HANDLE otherwise

-

---*/

+  @retval NULL if error parsing

+  @retval A non-NULL EFI_HANDLE otherwise

+**/

+EFI_HANDLE

+ParseGuidedSectionToolsFile (

+  IN CHAR8    *InputFile

+  )

 {

   EFI_STATUS Status;

   EFI_HANDLE MemoryFile;

@@ -74,31 +66,22 @@ Returns:
   return ParsedGuidedSectionTools;

 }

 

-

-EFI_HANDLE

-ParseGuidedSectionToolsMemoryFile (

-  IN EFI_HANDLE    InputFile

-  )

-/*++

-

-Routine Description:

-

+/**

   This function parses the tools_def.txt file.  It returns a

   EFI_HANDLE object which can be used for the other library

   functions and should be passed to FreeParsedGuidedSectionToolsHandle

   to free resources when the tools_def.txt information is no

   longer needed.

 

-Arguments:

-

-  InputFile     Memory file image.

+  @param InputFile     Memory file image.

 

-Returns:

-

-  NULL if error or EOF

-  InputBuffer otherwise

-

---*/

+  @retval NULL if error or EOF

+  @retval InputBuffer otherwise

+**/

+EFI_HANDLE

+ParseGuidedSectionToolsMemoryFile (

+  IN EFI_HANDLE    InputFile

+  )

 {

   EFI_STATUS  Status;

   CHAR8       *NextLine;

@@ -160,31 +143,22 @@ Returns:
   return FirstGuidTool;

 }

 

+/**

+  This function looks up the appropriate tool to use for extracting

+  a GUID defined FV section.

 

+  @param ParsedGuidedSectionToolsHandle    A parsed GUID section tools handle.

+  @param SectionGuid                       The GUID for the section.

+

+  @retval NULL     if no tool is found or there is another error

+  @retval Non-NULL The tool to use to access the section contents.  (The caller

+             must free the memory associated with this string.)

+**/

 CHAR8*

 LookupGuidedSectionToolPath (

   IN EFI_HANDLE ParsedGuidedSectionToolsHandle,

   IN EFI_GUID   *SectionGuid

   )

-/*++

-

-Routine Description:

-

-  This function looks up the appropriate tool to use for extracting

-  a GUID defined FV section.

-

-Arguments:

-

-  ParsedGuidedSectionToolsHandle    A parsed GUID section tools handle.

-  SectionGuid                       The GUID for the section.

-

-Returns:

-

-  NULL     - if no tool is found or there is another error

-  Non-NULL - The tool to use to access the section contents.  (The caller

-             must free the memory associated with this string.)

-

---*/

 {

   GUID_SEC_TOOL_ENTRY *GuidTool;