MdeModulePkg/Udf: Refine function description comments

[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UdfDxe / FileName.c

diff --git a/MdeModulePkg/Universal/Disk/UdfDxe/FileName.c b/MdeModulePkg/Universal/Disk/UdfDxe/FileName.c
index f73793320d1a6be5ecd25ebab341eda826c4fd2c..36551a4dbad45097af4543d1d59d3dd615833719 100644 (file)
--- a/MdeModulePkg/Universal/Disk/UdfDxe/FileName.c
+++ b/MdeModulePkg/Universal/Disk/UdfDxe/FileName.c
@@ -14,6 +14,14 @@
 \r
 #include "Udf.h"\r
 \r
+/**\r
+  Trim the leading and trailing spaces for a give Unicode string.\r
+\r
+  @param[in]  String              The Unicode string to trim.\r
+\r
+  @return  A pointer to the trimmed string.\r
+\r
+**/\r
 CHAR16 *\r
 TrimString (\r
   IN CHAR16    *String\r
@@ -35,6 +43,14 @@ TrimString (
   return String;\r
 }\r
 \r
+/**\r
+  Replace the content of a Unicode string with the content of another Unicode\r
+  string.\r
+\r
+  @param[in]  Destination         A pointer to a Unicode string.\r
+  @param[in]  Source              A pointer to a Unicode string.\r
+\r
+**/\r
 VOID\r
 ReplaceLeft (\r
   IN CHAR16         *Destination,\r
@@ -49,6 +65,15 @@ ReplaceLeft (
   }\r
 }\r
 \r
+/**\r
+  Remove one or more consecutive backslashes starting from the second character\r
+  of a given Unicode string.\r
+\r
+  @param[in]  String              A pointer to a Unicode string.\r
+\r
+  @return  A pointer to the modified string.\r
+\r
+**/\r
 CHAR16 *\r
 ExcludeTrailingBackslashes (\r
   IN CHAR16                    *String\r
@@ -85,7 +110,7 @@ Exit:
 \r
   @param[in] FileName Filename.\r
 \r
-  @retval @p FileName Filename mangled.\r
+  @retval The mangled Filename.\r
 \r
 **/\r
 CHAR16 *\r