add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel2CommandsLib / Map.c

diff --git a/ShellPkg/Library/UefiShellLevel2CommandsLib/Map.c b/ShellPkg/Library/UefiShellLevel2CommandsLib/Map.c
index 68130d4db834c5b8677e14cfc4373a744a5de185..266145c08d2706233fa20a5fb4460b9d161667c0 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel2CommandsLib/Map.c
+++ b/ShellPkg/Library/UefiShellLevel2CommandsLib/Map.c
@@ -516,18 +516,19 @@ CONST CHAR16 AnyF[] = L"F*";
 /**\r
   Function to display mapping information to the user.\r
 \r
-  if Specific is specified then Consist and Normal will be ignored since information will\r
+  If Specific is specified then Consist and Normal will be ignored since information will\r
   be printed for the specific item only.\r
 \r
-  @param[in] Verbose                TRUE to display (extra) verbose information\r
-  @param[in] Consist                TRUE to display consistent mappings\r
-  @param[in] Normal                 TRUE to display normal (not consist) mappings\r
-  @param[in] TypeString             pointer to string of filter types\r
-  @param[in] SFO                    TRUE to display output in Standard Output Format\r
-  @param[in] Specific               pointer to string for specific map to display\r
+  @param[in] Verbose                TRUE to display (extra) verbose information.\r
+  @param[in] Consist                TRUE to display consistent mappings.\r
+  @param[in] Normal                 TRUE to display normal (not consist) mappings.\r
+  @param[in] TypeString             Pointer to string of filter types.\r
+  @param[in] SFO                    TRUE to display output in Standard Output Format.\r
+  @param[in] Specific               Pointer to string for specific map to display.\r
+  @param[in] Header                 TRUE to print the header block.\r
 \r
-  @retval SHELL_SUCCESS               the display was printed\r
-  @retval SHELL_INVALID_PARAMETER     one of Consist or Normal must be TRUE if no Specific\r
+  @retval SHELL_SUCCESS               The display was printed.\r
+  @retval SHELL_INVALID_PARAMETER     One of Consist or Normal must be TRUE if no Specific.\r
 \r
 **/\r
 SHELL_STATUS\r