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 87059e12e05b69df34baeb0fe4a640ac638f722c..f2d1c60bf649d652d5cb9f6a741b2a30989e750e 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Hotkey.h
+++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.h
@@ -1,6 +1,8 @@
-/*++\r
+/** @file\r
+  Provides a way for 3rd party applications to register themselves for launch by the\r
+  Boot Manager based on hot key\r
 \r
-Copyright (c) 2007 - 2008, Intel Corporation\r
+Copyright (c) 2007 - 2008, Intel Corporation. <BR>\r
 All rights reserved. This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
 which accompanies this distribution.  The full text of the license may be found at\r
@@ -9,28 +11,17 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
-Module Name:\r
-\r
-  Hotkey.h\r
-\r
-Abstract:\r
-\r
-  Provides a way for 3rd party applications to register themselves for launch by the\r
-  Boot Manager based on hot key\r
-\r
-Revision History\r
+**/\r
 \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
@@ -44,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
-Routine Description:\r
+  );\r
 \r
-  Delete Key#### for the given Key Option number.\r
-\r
-Arguments:\r
 \r
-  KeyOptionNumber       - Key option number for Key####\r
+/**\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