fix ECC tool's warning

[mirror_edk2.git] / MdeModulePkg / Universal / Console / ConSplitterDxe / ConSplitterGraphics.c

diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c
index d67fdb2f50a48cd119d5c81c1a42226fd1f58274..1a0715e1417e480cbdfe457c27c7f453d3411ba9 100644 (file)
--- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c
+++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c
@@ -25,16 +25,17 @@ CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };
 \r
 /**\r
   Return the current video mode information. Also returns info about existence\r
-  of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
-  arguments are optional and only returned if a non NULL pointer is passed in.\r
+  of Graphics Output devices or UGA Draw devices in system, and whether the Std\r
+  In device is locked. GopUgaExists and StdInLocked parameters are optional, and\r
+  only returned if a non NULL pointer is passed in.\r
 \r
   @param  This                    Protocol instance pointer.\r
-  @param  Mode                    Are we in text of grahics mode.\r
-  @param  GopUgaExists            TRUE if Console Spliter has found a GOP or UGA device\r
+  @param  Mode                    Current video mode.\r
+  @param  GopUgaExists            TRUE if GOP Spliter has found a GOP/UGA device\r
   @param  StdInLocked             TRUE if StdIn device is keyboard locked\r
 \r
-  @retval EFI_SUCCESS             Mode information returned.\r
-  @retval EFI_INVALID_PARAMETER   Invalid parameters.\r
+  @retval EFI_SUCCESS             Video mode information is returned.\r
+  @retval EFI_INVALID_PARAMETER   Invalid parameters if Mode == NULL.\r
 \r
 **/\r
 EFI_STATUS\r