1 files changed, 44 insertions, 121 deletions
diff --git a/BaseTools/Source/C/Common/StringFuncs.h b/BaseTools/Source/C/Common/StringFuncs.h
index 8fc616de80..23dce27244 100644
--- a/BaseTools/Source/C/Common/StringFuncs.h
+++ b/BaseTools/Source/C/Common/StringFuncs.h
@@ -29,216 +29,139 @@ typedef struct {
 // Functions declarations
 //
 
+/**
+  Allocates a new string and copies 'String' to clone it
+
+  @param String          The string to clone
+
+  @return CHAR8* - NULL if there are not enough resources
+**/
 CHAR8*
 CloneString (
   IN CHAR8       *String
   )
 ;
-/**
-
-Routine Description:
 
-  Allocates a new string and copies 'String' to clone it
-
-Arguments:
-
-  String          The string to clone
-
-Returns:
+/**
+  Remove all comments, leading and trailing whitespace from the string.
 
-  CHAR8* - NULL if there are not enough resources
+  @param String          The string to 'strip'
 
+  @return EFI_STATUS
 **/
-
-
 EFI_STATUS
 StripInfDscStringInPlace (
   IN CHAR8       *String
   )
 ;
-/**
-
-Routine Description:
-
-  Remove all comments, leading and trailing whitespace from the string.
-
-Arguments:
 
-  String          The string to 'strip'
-
-Returns:
+/**
+  Creates and returns a 'split' STRING_LIST by splitting the string
+  on whitespace boundaries.
 
-  EFI_STATUS
+  @param String          The string to 'split'
 
+  @return EFI_STATUS
 **/
-
-
 STRING_LIST*
 SplitStringByWhitespace (
   IN CHAR8       *String
   )
 ;
-/**
-
-Routine Description:
-
-  Creates and returns a 'split' STRING_LIST by splitting the string
-  on whitespace boundaries.
-
-Arguments:
-
-  String          The string to 'split'
 
-Returns:
-
-  EFI_STATUS
+/**
+  Creates a new STRING_LIST with 0 strings.
 
+  @return STRING_LIST* - Null if there is not enough resources to create the object.
 **/
-
-
 STRING_LIST*
 NewStringList (
   )
 ;
-/**
 
-Routine Description:
 
-  Creates a new STRING_LIST with 0 strings.
-
-Returns:
-
-  STRING_LIST* - Null if there is not enough resources to create the object.
+/**
+  Adds String to StringList.  A new copy of String is made before it is
+  added to StringList.
 
+  @return EFI_STATUS
 **/
-
-
 EFI_STATUS
 AppendCopyOfStringToList (
   IN OUT STRING_LIST **StringList,
   IN CHAR8       *String
   )
 ;
-/**
-
-Routine Description:
-
-  Adds String to StringList.  A new copy of String is made before it is
-  added to StringList.
 
-Returns:
+/**
+  Removes the last string from StringList and frees the memory associated
+  with it.
 
-  EFI_STATUS
+  @param StringList        The string list to remove the string from
 
+  @return EFI_STATUS
 **/
-
-
 EFI_STATUS
 RemoveLastStringFromList (
   IN STRING_LIST       *StringList
   )
 ;
-/**
 
-Routine Description:
 
-  Removes the last string from StringList and frees the memory associated
-  with it.
-
-Arguments:
-
-  StringList        The string list to remove the string from
-
-Returns:
+/**
+  Allocates a STRING_LIST structure that can store StringCount strings.
 
-  EFI_STATUS
+  @param StringCount        The number of strings that need to be stored
 
+  @return EFI_STATUS
 **/
-
-
 STRING_LIST*
 AllocateStringListStruct (
   IN UINTN StringCount
   )
 ;
-/**
-
-Routine Description:
-
-  Allocates a STRING_LIST structure that can store StringCount strings.
-
-Arguments:
 
-  StringCount        The number of strings that need to be stored
 
-Returns:
+/**
+  Frees all memory associated with StringList.
 
-  EFI_STATUS
+  @param StringList        The string list to free
 
+  @return EFI_STATUS
 **/
-
-
 VOID
 FreeStringList (
   IN STRING_LIST       *StringList
   )
 ;
-/**
-
-Routine Description:
 
-  Frees all memory associated with StringList.
-
-Arguments:
 
-  StringList        The string list to free
-
-Returns:
+/**
+  Generates a string that represents the STRING_LIST
 
-  EFI_STATUS
+  @param StringList        The string list to convert to a string
 
+  @return CHAR8* The string list represented with a single string.  The returned
+           string must be freed by the caller.
 **/
-
-
 CHAR8*
 StringListToString (
   IN STRING_LIST       *StringList
   )
 ;
-/**
-
-Routine Description:
-
-  Generates a string that represents the STRING_LIST
-
-Arguments:
 
-  StringList        The string list to convert to a string
 
-Returns:
-
-  CHAR8* - The string list represented with a single string.  The returned
-           string must be freed by the caller.
+/**
+  Prints out the string list
 
+  @param StringList        The string list to print
 **/
-
-
 VOID
 PrintStringList (
   IN STRING_LIST       *StringList
   )
 ;
-/**
 
-Routine Description:
-
-  Prints out the string list
-
-Arguments:
-
-  StringList        The string list to print
-
-**/
 
 
 #endif