1.Review the comments;

2.Modify the extension comment for INF file.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7207 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf
index b6a4bfe6a86bb2b2067b680af6d3499c4767fb62..a12406c236af6e2036b4cf0314326ceacfe81ba3 100644 (file)
--- a/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf
+++ b/MdeModulePkg/Universal/Console/GraphicsConsoleDxe/GraphicsConsoleDxe.inf
@@ -53,12 +53,12 @@
   HiiLib\r
 \r
 [Protocols]\r
-  gEfiDevicePathProtocolGuid                    # PROTOCOL ALWAYS_CONSUMED\r
-  gEfiSimpleTextOutProtocolGuid                 # PROTOCOL BY_START\r
-  gEfiGraphicsOutputProtocolGuid                # PROTOCOL TO_START\r
-  gEfiUgaDrawProtocolGuid                       # PROTOCOL TO_START\r
-  gEfiHiiFontProtocolGuid                       # PROTOCOL TO_START\r
-  gEfiHiiDatabaseProtocolGuid                   # PROTOCOL TO_START   \r
+  gEfiDevicePathProtocolGuid                    ## CONSUMES\r
+  gEfiSimpleTextOutProtocolGuid                 ## BY_START\r
+  gEfiGraphicsOutputProtocolGuid                ## TO_START\r
+  gEfiUgaDrawProtocolGuid                       ## TO_START\r
+  gEfiHiiFontProtocolGuid                       ## TO_START\r
+  gEfiHiiDatabaseProtocolGuid                   ## TO_START   \r
 \r
 [FeaturePcd.common]\r
   gEfiMdePkgTokenSpaceGuid.PcdUgaConsumeSupport
\ No newline at end of file

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c b/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c
index 58d35f125624982e375309ffec902f62a5b0251b..c24108b51289bc0465e6af2efd56f7f159ee8b4d 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Ansi.c
@@ -21,8 +21,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 AnsiRawDataToUnicode (\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c
index 6fd19de6645e2b63954270dbe95d0ace703ceb29..f39cbcd8f5cb14ae4a74040b0100eebdb1bf5f73 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.c
@@ -958,8 +958,6 @@ TerminalFreeNotifyList (
   @param  VariableName           The Console Device Environment Variable.\r
   @param  ParentDevicePath       The terminal device path to be updated.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 TerminalUpdateConsoleDevVariable (\r
@@ -1023,8 +1021,6 @@ TerminalUpdateConsoleDevVariable (
   @param  VariableName           Console Device Environment Variables.\r
   @param  ParentDevicePath       The terminal device path to be updated.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 TerminalRemoveConsoleDevVariable (\r
@@ -1288,8 +1284,6 @@ SetTerminalDevicePath (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeRawFiFo (\r
@@ -1307,8 +1301,6 @@ InitializeRawFiFo (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeUnicodeFiFo (\r
@@ -1326,8 +1318,6 @@ InitializeUnicodeFiFo (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeEfiKeyFiFo (\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
index 1cea44b489928ec596423bfa65dbf49484259084..f228400142aae6eb3f473f08f502a0411c847639 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Terminal.h
@@ -191,8 +191,8 @@ InitializeTerminal (
   @param  This                     Indicates the calling context.\r
   @param  ExtendedVerification     Skip by this driver.\r
 \r
-  @return EFI_SUCCESS              The reset operation succeeds.\r
-  @return EFI_DEVICE_ERROR         The dependent serial port reset fails.\r
+  @retval EFI_SUCCESS              The reset operation succeeds.\r
+  @retval EFI_DEVICE_ERROR         The dependent serial port reset fails.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -211,9 +211,9 @@ TerminalConInReset (
                               keystroke information for the key that was sent\r
                               from terminal.\r
 \r
-  @return EFI_SUCCESS         The keystroke information is returned successfully.\r
-  @return EFI_NOT_READY       There is no keystroke data available.\r
-  @return EFI_DEVICE_ERROR    The dependent serial device encounters error.\r
+  @retval EFI_SUCCESS         The keystroke information is returned successfully.\r
+  @retval EFI_NOT_READY       There is no keystroke data available.\r
+  @retval EFI_DEVICE_ERROR    The dependent serial device encounters error.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -250,8 +250,6 @@ IsKeyRegistered (
   @param  Event                    Indicates the event that invoke this function.\r
   @param  Context                  Indicates the calling context.\r
 \r
-  @return none.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -382,8 +380,6 @@ TerminalConInUnregisterKeyNotify (
   @param  Event                    Indicates the event that invoke this function.\r
   @param  Context                  Indicates the calling context.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -403,8 +399,8 @@ TerminalConInWaitForKey (
                                 exhaustive verification operation of the device\r
                                 during reset.\r
 \r
-  @return EFI_SUCCESS           The reset operation succeeds.\r
-  @return EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.\r
+  @retval EFI_SUCCESS           The reset operation succeeds.\r
+  @retval EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -447,8 +443,8 @@ TerminalConOutOutputString (
   @param  This              Indicates the calling context.\r
   @param  WString           The Null-terminated Unicode string to be tested.\r
 \r
-  @return EFI_SUCCESS       The terminal is capable of rendering the output string.\r
-  @return EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.\r
+  @retval EFI_SUCCESS       The terminal is capable of rendering the output string.\r
+  @retval EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -470,9 +466,9 @@ TerminalConOutTestString (
   @param Columns     The returned columns of the requested mode.\r
   @param Rows        The returned rows of the requested mode.\r
 \r
-  @return EFI_SUCCESS       The requested mode information is returned.\r
-  @return EFI_UNSUPPORTED   The mode number is not valid.\r
-  @return EFI_DEVICE_ERROR\r
+  @retval EFI_SUCCESS       The requested mode information is returned.\r
+  @retval EFI_UNSUPPORTED   The mode number is not valid.\r
+  @retval EFI_DEVICE_ERROR\r
 \r
 **/\r
 EFI_STATUS\r
@@ -492,10 +488,10 @@ TerminalConOutQueryMode (
   @param This          Indicates the calling context.\r
   @param ModeNumber    The text mode to set.\r
 \r
-  @return EFI_SUCCESS       The requested text mode is set.\r
-  @return EFI_DEVICE_ERROR  The requested text mode cannot be set \r
+  @retval EFI_SUCCESS       The requested text mode is set.\r
+  @retval EFI_DEVICE_ERROR  The requested text mode cannot be set \r
                             because of serial device error.\r
-  @return EFI_UNSUPPORTED   The text mode number is not valid.\r
+  @retval EFI_UNSUPPORTED   The text mode number is not valid.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -512,9 +508,9 @@ TerminalConOutSetMode (
   @param Attribute   The attribute to set. Only bit0..6 are valid, all other bits\r
                      are undefined and must be zero.\r
 \r
-  @return EFI_SUCCESS        The requested attribute is set.\r
-  @return EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.\r
-  @return EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.\r
+  @retval EFI_SUCCESS        The requested attribute is set.\r
+  @retval EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.\r
+  @retval EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -531,9 +527,9 @@ TerminalConOutSetAttribute (
 \r
   @param This     Indicates the calling context.\r
 \r
-  @return EFI_SUCCESS       The operation completed successfully.\r
-  @return EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.\r
-  @return EFI_UNSUPPORTED   The terminal is not in a valid display mode.\r
+  @retval EFI_SUCCESS       The operation completed successfully.\r
+  @retval EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.\r
+  @retval EFI_UNSUPPORTED   The terminal is not in a valid display mode.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -549,9 +545,9 @@ TerminalConOutClearScreen (
   @param Column    The row to set cursor to.\r
   @param Row       The column to set cursor to.\r
 \r
-  @return EFI_SUCCESS       The operation completed successfully.\r
-  @return EFI_DEVICE_ERROR  The request fails due to serial port error.\r
-  @return EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position\r
+  @retval EFI_SUCCESS       The operation completed successfully.\r
+  @retval EFI_DEVICE_ERROR  The request fails due to serial port error.\r
+  @retval EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position\r
                             is invalid for current mode.\r
 \r
 **/\r
@@ -571,8 +567,8 @@ TerminalConOutSetCursorPosition (
   @param Visible   If TRUE, the cursor is set to be visible,\r
                    If FALSE, the cursor is set to be invisible.\r
 \r
-  @return EFI_SUCCESS      The request is valid.\r
-  @return EFI_UNSUPPORTED  The terminal does not support cursor hidden.\r
+  @retval EFI_SUCCESS      The request is valid.\r
+  @retval EFI_UNSUPPORTED  The terminal does not support cursor hidden.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -833,8 +829,6 @@ TerminalUpdateConsoleDevVariable (
   @param  VariableName           A pointer to the variable name.\r
   @param  ParentDevicePath       A pointer to the parent device path.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 TerminalRemoveConsoleDevVariable (\r
@@ -855,7 +849,7 @@ TerminalRemoveConsoleDevVariable (
           NULL regturned.\r
 \r
 **/\r
-VOID                                *\r
+VOID *\r
 TerminalGetVariableAndSize (\r
   IN  CHAR16              *Name,\r
   IN  EFI_GUID            *VendorGuid,\r
@@ -886,8 +880,6 @@ SetTerminalDevicePath (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeRawFiFo (\r
@@ -899,8 +891,6 @@ InitializeRawFiFo (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeUnicodeFiFo (\r
@@ -912,8 +902,6 @@ InitializeUnicodeFiFo (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 InitializeEfiKeyFiFo (\r
@@ -926,9 +914,9 @@ InitializeEfiKeyFiFo (
   @param  SerialIo           Serial I/O protocl attached to the serial device.\r
   @param  Input              The fetched key.\r
 \r
-  @return EFI_NOT_READY      If serial buffer is empty.\r
-  @return EFI_DEVICE_ERROR   If reading serial buffer encounter error.\r
-  @return EFI_SUCCESS        If reading serial buffer successfully, put\r
+  @retval EFI_NOT_READY      If serial buffer is empty.\r
+  @retval EFI_DEVICE_ERROR   If reading serial buffer encounter error.\r
+  @retval EFI_SUCCESS        If reading serial buffer successfully, put\r
                              the fetched key to the parameter output.\r
 \r
 **/\r
@@ -944,8 +932,8 @@ GetOneKeyFromSerial (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Input                The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Raw Data buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Raw Data buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -961,8 +949,8 @@ RawFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Raw Data FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Raw Data FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -976,8 +964,8 @@ RawFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Raw Data FIFO buffer is empty.\r
-  @return FLASE                If Raw Data FIFO buffer is not empty.\r
+  @retval TRUE                 If Raw Data FIFO buffer is empty.\r
+  @retval FLASE                If Raw Data FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -990,8 +978,8 @@ IsRawFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Raw Data FIFO buffer is full.\r
-  @return FLASE                If Raw Data FIFO buffer is not full.\r
+  @retval TRUE                 If Raw Data FIFO buffer is full.\r
+  @retval FLASE                If Raw Data FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1005,8 +993,8 @@ IsRawFiFoFull (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Key                  The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If FIFO buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -1022,8 +1010,8 @@ EfiKeyFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1037,8 +1025,8 @@ EfiKeyFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If FIFO buffer is empty.\r
-  @return FLASE                If FIFO buffer is not empty.\r
+  @retval TRUE                 If FIFO buffer is empty.\r
+  @retval FLASE                If FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1051,8 +1039,8 @@ IsEfiKeyFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If FIFO buffer is full.\r
-  @return FLASE                If FIFO buffer is not full.\r
+  @retval TRUE                 If FIFO buffer is full.\r
+  @retval FLASE                If FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1066,8 +1054,8 @@ IsEfiKeyFiFoFull (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Input                The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Unicode FIFO buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Unicode FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -1083,8 +1071,8 @@ UnicodeFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Unicode FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Unicode FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1098,8 +1086,8 @@ UnicodeFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Unicode FIFO buffer is empty.\r
-  @return FLASE                If Unicode FIFO buffer is not empty.\r
+  @retval TRUE                 If Unicode FIFO buffer is empty.\r
+  @retval FLASE                If Unicode FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1112,8 +1100,8 @@ IsUnicodeFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Unicode FIFO buffer is full.\r
-  @return FLASE                If Unicode FIFO buffer is not full.\r
+  @retval TRUE                 If Unicode FIFO buffer is full.\r
+  @retval FLASE                If Unicode FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1140,8 +1128,6 @@ UnicodeFiFoGetKeyCount (
 \r
   @param  TerminalDevice       Terminal driver private structure.\r
 \r
-  @return none.\r
-\r
 **/\r
 VOID\r
 TranslateRawDataToEfiKey (\r
@@ -1158,8 +1144,6 @@ TranslateRawDataToEfiKey (
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 AnsiRawDataToUnicode (\r
@@ -1228,8 +1212,6 @@ AnsiRawDataToUnicode (
 \r
   @param TerminalDevice   The terminal device to use to translate raw input into EFI Keys\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UnicodeToEfiKey (\r
@@ -1263,8 +1245,6 @@ AnsiTestString (
 \r
   @param VtUtf8Device          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 VTUTF8RawDataToUnicode (\r
@@ -1300,8 +1280,6 @@ VTUTF8TestString (
   @param  Utf8Char         Return VT-UTF8 character set.\r
   @param  ValidBytes       The count of valid VT-UTF8 characters. If\r
                            ValidBytes is zero, no valid VT-UTF8 returned.\r
-  \r
-  @return None.\r
 \r
 **/\r
 VOID\r
@@ -1340,8 +1318,6 @@ GetOneValidUtf8Char (
   @param  Utf8Char         VT-UTF8 character set needs translating.\r
   @param  ValidBytes       The count of valid VT-UTF8 characters.\r
   @param  UnicodeChar      Returned unicode character. \r
-  \r
-  @return None.\r
 \r
 **/\r
 VOID\r
@@ -1364,7 +1340,7 @@ Utf8ToUnicode (
   @param  Ascii        Optional pointer to return ASCII equivalent of\r
                        Graphic.\r
 \r
-  @return TRUE         If Graphic is a supported Unicode Box Drawing character.\r
+  @retval TRUE         If Graphic is a supported Unicode Box Drawing character.\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
index 406dcb794245f5e0e882ee43a681bcfb1271d9b7..4bb2e77d01504efafd8e2b49885e20d6e5ed7cd2 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConIn.c
@@ -92,8 +92,8 @@ ReadKeyStrokeWorker (
   @param  This                     Indicates the calling context.\r
   @param  ExtendedVerification     Skip by this driver.\r
 \r
-  @return EFI_SUCCESS              The reset operation succeeds.\r
-  @return EFI_DEVICE_ERROR         The dependent serial port reset fails.\r
+  @retval EFI_SUCCESS              The reset operation succeeds.\r
+  @retval EFI_DEVICE_ERROR         The dependent serial port reset fails.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -145,9 +145,9 @@ TerminalConInReset (
                               keystroke information for the key that was sent\r
                               from terminal.\r
 \r
-  @return EFI_SUCCESS         The keystroke information is returned successfully.\r
-  @return EFI_NOT_READY       There is no keystroke data available.\r
-  @return EFI_DEVICE_ERROR    The dependent serial device encounters error.\r
+  @retval EFI_SUCCESS         The keystroke information is returned successfully.\r
+  @retval EFI_NOT_READY       There is no keystroke data available.\r
+  @retval EFI_DEVICE_ERROR    The dependent serial device encounters error.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -218,8 +218,6 @@ IsKeyRegistered (
   @param  Event                    Indicates the event that invoke this function.\r
   @param  Context                  Indicates the calling context.\r
 \r
-  @return none.\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -505,8 +503,6 @@ TerminalConInUnregisterKeyNotify (
 \r
   @param  TerminalDevice       Terminal driver private structure.\r
 \r
-  @return none.\r
-\r
 **/\r
 VOID\r
 TranslateRawDataToEfiKey (\r
@@ -546,8 +542,6 @@ TranslateRawDataToEfiKey (
   @param  Event                    Indicates the event that invoke this function.\r
   @param  Context                  Indicates the calling context.\r
 \r
-  @return None\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -693,9 +687,9 @@ TerminalConInCheckForKey (
   @param  SerialIo           Serial I/O protocol attached to the serial device.\r
   @param  Output             The fetched key.\r
 \r
-  @return EFI_NOT_READY      If serial buffer is empty.\r
-  @return EFI_DEVICE_ERROR   If reading serial buffer encounter error.\r
-  @return EFI_SUCCESS        If reading serial buffer successfully, put\r
+  @retval EFI_NOT_READY      If serial buffer is empty.\r
+  @retval EFI_DEVICE_ERROR   If reading serial buffer encounter error.\r
+  @retval EFI_SUCCESS        If reading serial buffer successfully, put\r
                              the fetched key to the parameter output.\r
 \r
 **/\r
@@ -739,8 +733,8 @@ GetOneKeyFromSerial (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Input                The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Raw Data buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Raw Data buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -774,8 +768,8 @@ RawFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Raw Data FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Raw Data FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -808,8 +802,8 @@ RawFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Raw Data FIFO buffer is empty.\r
-  @return FLASE                If Raw Data FIFO buffer is not empty.\r
+  @retval TRUE                 If Raw Data FIFO buffer is empty.\r
+  @retval FLASE                If Raw Data FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -829,8 +823,8 @@ IsRawFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Raw Data FIFO buffer is full.\r
-  @return FLASE                If Raw Data FIFO buffer is not full.\r
+  @retval TRUE                 If Raw Data FIFO buffer is full.\r
+  @retval FLASE                If Raw Data FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -858,8 +852,8 @@ IsRawFiFoFull (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Key                  The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If FIFO buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -893,8 +887,8 @@ EfiKeyFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -928,8 +922,8 @@ EfiKeyFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If FIFO buffer is empty.\r
-  @return FLASE                If FIFO buffer is not empty.\r
+  @retval TRUE                 If FIFO buffer is empty.\r
+  @retval FLASE                If FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -949,8 +943,8 @@ IsEfiKeyFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If FIFO buffer is full.\r
-  @return FLASE                If FIFO buffer is not full.\r
+  @retval TRUE                 If FIFO buffer is full.\r
+  @retval FLASE                If FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -978,8 +972,8 @@ IsEfiKeyFiFoFull (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Input                The key will be input.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Unicode FIFO buffer is full before key insertion,\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Unicode FIFO buffer is full before key insertion,\r
                                and the key is lost.\r
 \r
 **/\r
@@ -1013,8 +1007,8 @@ UnicodeFiFoInsertOneKey (
   @param  TerminalDevice       Terminal driver private structure.\r
   @param  Output               The key will be removed.\r
 \r
-  @return TRUE                 If insert successfully.\r
-  @return FLASE                If Unicode FIFO buffer is empty before remove operation.\r
+  @retval TRUE                 If insert successfully.\r
+  @retval FLASE                If Unicode FIFO buffer is empty before remove operation.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1047,8 +1041,8 @@ UnicodeFiFoRemoveOneKey (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Unicode FIFO buffer is empty.\r
-  @return FLASE                If Unicode FIFO buffer is not empty.\r
+  @retval TRUE                 If Unicode FIFO buffer is empty.\r
+  @retval FLASE                If Unicode FIFO buffer is not empty.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1068,8 +1062,8 @@ IsUnicodeFiFoEmpty (
 \r
   @param  TerminalDevice       Terminal driver private structure\r
 \r
-  @return TRUE                 If Unicode FIFO buffer is full.\r
-  @return FLASE                If Unicode FIFO buffer is not full.\r
+  @retval TRUE                 If Unicode FIFO buffer is full.\r
+  @retval FLASE                If Unicode FIFO buffer is not full.\r
 \r
 **/\r
 BOOLEAN\r
@@ -1122,8 +1116,6 @@ UnicodeFiFoGetKeyCount (
   \r
   @param TerminalDevice   The terminal device to use to translate raw input into EFI Keys\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UnicodeToEfiKeyFlushState (\r
@@ -1240,8 +1232,6 @@ UnicodeToEfiKeyFlushState (
 \r
   @param TerminalDevice   The terminal device to use to translate raw input into EFI Keys\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 UnicodeToEfiKey (\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c
index 83f7c900e3b6175b02ae0a8e2ff96ce8c06b4289..3c2f45bb6b21b01892a18bfdb6215071fa7babd0 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalConOut.c
@@ -99,8 +99,8 @@ CHAR16 mSetCursorPositionString[]  = { ESC, '[', '0', '0', ';', '0', '0', 'H', 0
                                 exhaustive verification operation of the device\r
                                 during reset.\r
 \r
-  @return EFI_SUCCESS           The reset operation succeeds.\r
-  @return EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.\r
+  @retval EFI_SUCCESS           The reset operation succeeds.\r
+  @retval EFI_DEVICE_ERROR      The terminal is not functioning correctly or the serial port reset fails.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -346,8 +346,8 @@ OutputError:
   @param  This              Indicates the calling context.\r
   @param  WString           The Null-terminated Unicode string to be tested.\r
 \r
-  @return EFI_SUCCESS       The terminal is capable of rendering the output string.\r
-  @return EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.\r
+  @retval EFI_SUCCESS       The terminal is capable of rendering the output string.\r
+  @retval EFI_UNSUPPORTED   Some of the characters in the Unicode string cannot be rendered.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -399,9 +399,9 @@ TerminalConOutTestString (
   @param Columns     The returned columns of the requested mode.\r
   @param Rows        The returned rows of the requested mode.\r
 \r
-  @return EFI_SUCCESS       The requested mode information is returned.\r
-  @return EFI_UNSUPPORTED   The mode number is not valid.\r
-  @return EFI_DEVICE_ERROR\r
+  @retval EFI_SUCCESS       The requested mode information is returned.\r
+  @retval EFI_UNSUPPORTED   The mode number is not valid.\r
+  @retval EFI_DEVICE_ERROR\r
 \r
 **/\r
 EFI_STATUS\r
@@ -444,10 +444,10 @@ TerminalConOutQueryMode (
   @param This          Indicates the calling context.\r
   @param ModeNumber    The text mode to set.\r
 \r
-  @return EFI_SUCCESS       The requested text mode is set.\r
-  @return EFI_DEVICE_ERROR  The requested text mode cannot be set \r
+  @retval EFI_SUCCESS       The requested text mode is set.\r
+  @retval EFI_DEVICE_ERROR  The requested text mode cannot be set \r
                             because of serial device error.\r
-  @return EFI_UNSUPPORTED   The text mode number is not valid.\r
+  @retval EFI_UNSUPPORTED   The text mode number is not valid.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -503,9 +503,9 @@ TerminalConOutSetMode (
   @param Attribute   The attribute to set. Only bit0..6 are valid, all other bits\r
                      are undefined and must be zero.\r
 \r
-  @return EFI_SUCCESS        The requested attribute is set.\r
-  @return EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.\r
-  @return EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.\r
+  @retval EFI_SUCCESS        The requested attribute is set.\r
+  @retval EFI_DEVICE_ERROR   The requested attribute cannot be set due to serial port error.\r
+  @retval EFI_UNSUPPORTED    The attribute requested is not defined by EFI spec.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -676,9 +676,9 @@ TerminalConOutSetAttribute (
 \r
   @param This     Indicates the calling context.\r
 \r
-  @return EFI_SUCCESS       The operation completed successfully.\r
-  @return EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.\r
-  @return EFI_UNSUPPORTED   The terminal is not in a valid display mode.\r
+  @retval EFI_SUCCESS       The operation completed successfully.\r
+  @retval EFI_DEVICE_ERROR  The terminal screen cannot be cleared due to serial port error.\r
+  @retval EFI_UNSUPPORTED   The terminal is not in a valid display mode.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -716,9 +716,9 @@ TerminalConOutClearScreen (
   @param Column    The row to set cursor to.\r
   @param Row       The column to set cursor to.\r
 \r
-  @return EFI_SUCCESS       The operation completed successfully.\r
-  @return EFI_DEVICE_ERROR  The request fails due to serial port error.\r
-  @return EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position\r
+  @retval EFI_SUCCESS       The operation completed successfully.\r
+  @retval EFI_DEVICE_ERROR  The request fails due to serial port error.\r
+  @retval EFI_UNSUPPORTED   The terminal is not in a valid text mode, or the cursor position\r
                             is invalid for current mode.\r
 \r
 **/\r
@@ -794,8 +794,8 @@ TerminalConOutSetCursorPosition (
   @param Visible   If TRUE, the cursor is set to be visible,\r
                    If FALSE, the cursor is set to be invisible.\r
 \r
-  @return EFI_SUCCESS      The request is valid.\r
-  @return EFI_UNSUPPORTED  The terminal does not support cursor hidden.\r
+  @retval EFI_SUCCESS      The request is valid.\r
+  @retval EFI_UNSUPPORTED  The terminal does not support cursor hidden.\r
 \r
 **/\r
 EFI_STATUS\r
@@ -822,7 +822,7 @@ TerminalConOutEnableCursor (
   @param  Ascii        Optional pointer to return ASCII equivalent of\r
                        Graphic.\r
 \r
-  @return TRUE         If Graphic is a supported Unicode Box Drawing character.\r
+  @retval TRUE         If Graphic is a supported Unicode Box Drawing character.\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf
index ff0f788c88f20371ac8374c2c0dbfb9e06b631ba..67e154df56892e636e441c022c008155500a8985 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/TerminalDxe.inf
@@ -60,20 +60,20 @@
   BaseLib\r
 \r
 [Guids]\r
-  gEfiGlobalVariableGuid                        # SOMETIMES_CONSUMED L"ErrOutDev"\r
-  gEfiVTUTF8Guid                                # SOMETIMES_CONSUMED\r
-  gEfiVT100Guid                                 # SOMETIMES_CONSUMED\r
-  gEfiVT100PlusGuid                             # SOMETIMES_CONSUMED\r
-  gEfiPcAnsiGuid                                # SOMETIMES_CONSUMED\r
-  gSimpleTextInExNotifyGuid                     # SOMETIMES_CONSUMED\r
-  gEfiHotPlugDeviceGuid                         # PROTOCOL SOMETIMES_CONSUMED\r
+  gEfiGlobalVariableGuid                        ## SOMETIMES_CONSUMES ## Variable:L"ErrOutDev"\r
+  gEfiVTUTF8Guid                                ## SOMETIMES_CONSUMES ## GUID\r
+  gEfiVT100Guid                                 ## SOMETIMES_CONSUMES ## GUID\r
+  gEfiVT100PlusGuid                             ## SOMETIMES_CONSUMES ## GUID \r
+  gEfiPcAnsiGuid                                ## SOMETIMES_CONSUMES ## GUID\r
+  gSimpleTextInExNotifyGuid                     ## SOMETIMES_CONSUMES ##\r
+  gEfiHotPlugDeviceGuid                         ## SOMETIMES_CONSUMES ##\r
   \r
 [Protocols]\r
-  gEfiSerialIoProtocolGuid                      # PROTOCOL TO_START\r
-  gEfiDevicePathProtocolGuid                    # PROTOCOL TO_START\r
-  gEfiSimpleTextInProtocolGuid                  # PROTOCOL BY_START\r
-  gEfiSimpleTextInputExProtocolGuid             # PROTOCOL BY_START\r
-  gEfiSimpleTextOutProtocolGuid                 # PROTOCOL BY_START\r
+  gEfiSerialIoProtocolGuid                      ## TO_START\r
+  gEfiDevicePathProtocolGuid                    ## TO_START\r
+  gEfiSimpleTextInProtocolGuid                  ## BY_START\r
+  gEfiSimpleTextInputExProtocolGuid             ## BY_START\r
+  gEfiSimpleTextOutProtocolGuid                 ## BY_START\r
 \r
 [Pcd]\r
   gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleError\r

diff --git a/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c b/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c
index 6b1ec577f810ea8e5f2f9bff63c407a750f2855c..179f718e15d52f48bf8a5266b98c1ebe253f664a 100644 (file)
--- a/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c
+++ b/MdeModulePkg/Universal/Console/TerminalDxe/Vtutf8.c
@@ -20,8 +20,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
   @param TerminalDevice          The terminal device.\r
 \r
-  @return None.\r
-\r
 **/\r
 VOID\r
 VTUTF8RawDataToUnicode (\r
@@ -179,8 +177,6 @@ GetOneValidUtf8Char (
   @param  Utf8Char         VT-UTF8 character set needs translating.\r
   @param  ValidBytes       The count of valid VT-UTF8 characters.\r
   @param  UnicodeChar      Returned unicode character. \r
-  \r
-  @return None.\r
 \r
 **/\r
 VOID\r
@@ -255,8 +251,6 @@ Utf8ToUnicode (
   @param  Utf8Char         Return VT-UTF8 character set.\r
   @param  ValidBytes       The count of valid VT-UTF8 characters. If\r
                            ValidBytes is zero, no valid VT-UTF8 returned.\r
-  \r
-  @return None.\r
 \r
 **/\r
 VOID\r