Clean up to update the reference of the these macros:

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / Hotkey.h

diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.h b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
index c34026b264fea3848c78f492a5ceec26a7b8e52d..f2d1c60bf649d652d5cb9f6a741b2a30989e750e 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.h
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
@@ -13,15 +13,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 **/\r
 \r
-#ifndef _HOTKEY_H\r
-#define _HOTKEY_H\r
+#ifndef _HOTKEY_H_\r
+#define _HOTKEY_H_\r
 \r
 #include "Bds.h"\r
 #include "String.h"\r
 \r
 #define GET_KEY_CODE_COUNT(KeyOptions)      (((KeyOptions) & EFI_KEY_CODE_COUNT) >> 8)\r
 \r
-#define BDS_HOTKEY_OPTION_SIGNATURE EFI_SIGNATURE_32 ('B', 'd', 'K', 'O')\r
+#define BDS_HOTKEY_OPTION_SIGNATURE SIGNATURE_32 ('B', 'd', 'K', 'O')\r
 typedef struct {\r
   UINTN                     Signature;\r
   LIST_ENTRY                Link;\r
@@ -35,74 +35,56 @@ typedef struct {
 \r
 #define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)\r
 \r
-#define VarKeyOrder       L"KeyOrder"\r
+#define VAR_KEY_ORDER       L"KeyOrder"\r
 \r
+/**\r
+\r
+  Create Key#### for the given hotkey.\r
+\r
+\r
+  @param KeyOption       - The Hot Key Option to be added.\r
+  @param KeyOptionNumber - The key option number for Key#### (optional).\r
+\r
+  @retval  EFI_SUCCESS            Register hotkey successfully.\r
+  @retval  EFI_INVALID_PARAMETER  The hotkey option is invalid.\r
+\r
+**/\r
 EFI_STATUS\r
 RegisterHotkey (\r
   IN EFI_KEY_OPTION     *KeyOption,\r
   OUT UINT16            *KeyOptionNumber\r
-)\r
-/*++\r
+  );\r
 \r
-Routine Description:\r
+/**\r
 \r
-  Create Key#### for the given hotkey.\r
-\r
-Arguments:\r
-\r
-  KeyOption             - The Hot Key Option to be added.\r
-  KeyOptionNumber       - The key option number for Key#### (optional).\r
+  Delete Key#### for the given Key Option number.\r
 \r
-Returns:\r
 \r
-  EFI_SUCCESS           - Register hotkey successfully.\r
-  EFI_INVALID_PARAMETER - The hotkey option is invalid.\r
+  @param KeyOptionNumber - Key option number for Key####\r
 \r
---*/\r
-;\r
+  @retval  EFI_SUCCESS            Unregister hotkey successfully.\r
+  @retval  EFI_NOT_FOUND          No Key#### is found for the given Key Option number.\r
 \r
+**/\r
 EFI_STATUS\r
 UnregisterHotkey (\r
   IN UINT16             KeyOptionNumber\r
-)\r
-/*++\r
+  );\r
 \r
-Routine Description:\r
 \r
-  Delete Key#### for the given Key Option number.\r
+/**\r
 \r
-Arguments:\r
-\r
-  KeyOptionNumber       - Key option number for Key####\r
-\r
-Returns:\r
+  Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
 \r
-  EFI_SUCCESS           - Unregister hotkey successfully.\r
-  EFI_NOT_FOUND         - No Key#### is found for the given Key Option number.\r
 \r
---*/\r
-;\r
+  @param VOID\r
 \r
+  @retval  EFI_SUCCESS    Hotkey services successfully initialized.\r
 \r
+**/\r
 EFI_STATUS\r
 InitializeHotkeyService (\r
   VOID\r
-  )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-  Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
-\r
-Arguments:\r
-\r
-  None\r
-\r
-Returns:\r
-\r
-  EFI_SUCCESS   - Hotkey services successfully initialized.\r
-\r
---*/\r
-;\r
+  );\r
 \r
 #endif\r