Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / LegacyBios.h

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
index eef3fbe16c22a4ef5da337dd047f8f5a07794726..c881d9c2c50b43ff07a0396b24ddf5a88dff6407 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyBios.h
@@ -12,7 +12,7 @@
   You most likely should not use this protocol! Find the EFI way to solve the\r
   problem to make your code portable\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, Intel Corporation\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
@@ -470,62 +470,71 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   Abstracts the traditional BIOS from the rest of EFI. The LegacyBoot()\r
   member function allows the BDS to support booting a traditional OS.\r
   EFI thunks drivers that make EFI bindings for BIOS INT services use\r
   all the other member functions.\r
-\r
-  @param Int86\r
-  Performs traditional software INT. See the Int86() function description.\r
-\r
-  @param FarCall86\r
-  Performs a far call into Compatibility16 or traditional OpROM code.\r
-\r
-  @param CheckPciRom\r
-  Checks if a traditional OpROM exists for this device.\r
-\r
-  @param InstallPciRom\r
-  Loads a traditional OpROM in traditional OpROM address space.\r
-\r
-  @param LegacyBoot\r
-  Boots a traditional OS.\r
-\r
-  @param UpdateKeyboardLedStatus\r
-  Updates BDA to reflect the current EFI keyboard LED status.\r
-\r
-  @param GetBbsInfo\r
-  Allows an external agent, such as BIOS Setup, to get the BBS data.\r
-\r
-  @param ShadowAllLegacyOproms\r
-  Causes all legacy OpROMs to be shadowed.\r
-\r
-  @param PrepareToBootEfi\r
-  Performs all actions prior to boot. Used when booting an EFI-aware OS\r
-  rather than a legacy OS.\r
-\r
-  @param GetLegacyRegion\r
-  Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
-\r
-  @param CopyLegacyRegion\r
-  Allows EFI to copy data to the area specified by GetLegacyRegion.\r
-\r
-  @param BootUnconventionalDevice\r
-  Allows the user to boot off an unconventional device such as a PARTIES partition.\r
-\r
 **/\r
 struct _EFI_LEGACY_BIOS_PROTOCOL {\r
+  ///\r
+  /// Performs traditional software INT. See the Int86() function description.\r
+  ///\r
   EFI_LEGACY_BIOS_INT86                       Int86;\r
+  \r
+  ///\r
+  /// Performs a far call into Compatibility16 or traditional OpROM code.\r
+  ///\r
   EFI_LEGACY_BIOS_FARCALL86                   FarCall86;\r
+  \r
+  ///\r
+  /// Checks if a traditional OpROM exists for this device.\r
+  ///\r
   EFI_LEGACY_BIOS_CHECK_ROM                   CheckPciRom;\r
+  \r
+  ///\r
+  /// Loads a traditional OpROM in traditional OpROM address space.\r
+  ///\r
   EFI_LEGACY_BIOS_INSTALL_ROM                 InstallPciRom;\r
+  \r
+  ///\r
+  /// Boots a traditional OS.\r
+  ///\r
   EFI_LEGACY_BIOS_BOOT                        LegacyBoot;\r
+  \r
+  ///\r
+  /// Updates BDA to reflect the current EFI keyboard LED status.\r
+  ///\r
   EFI_LEGACY_BIOS_UPDATE_KEYBOARD_LED_STATUS  UpdateKeyboardLedStatus;\r
+  \r
+  ///\r
+  /// Allows an external agent, such as BIOS Setup, to get the BBS data.\r
+  ///\r
   EFI_LEGACY_BIOS_GET_BBS_INFO                GetBbsInfo;\r
+  \r
+  ///\r
+  /// Causes all legacy OpROMs to be shadowed.\r
+  ///\r
   EFI_LEGACY_BIOS_SHADOW_ALL_LEGACY_OPROMS    ShadowAllLegacyOproms;\r
+  \r
+  ///\r
+  /// Performs all actions prior to boot. Used when booting an EFI-aware OS\r
+  /// rather than a legacy OS.  \r
+  ///\r
   EFI_LEGACY_BIOS_PREPARE_TO_BOOT_EFI         PrepareToBootEfi;\r
+  \r
+  ///\r
+  /// Allows EFI to reserve an area in the 0xE0000 or 0xF0000 block.\r
+  ///\r
   EFI_LEGACY_BIOS_GET_LEGACY_REGION           GetLegacyRegion;\r
+  \r
+  ///\r
+  /// Allows EFI to copy data to the area specified by GetLegacyRegion.\r
+  ///\r
   EFI_LEGACY_BIOS_COPY_LEGACY_REGION          CopyLegacyRegion;\r
+  \r
+  ///\r
+  /// Allows the user to boot off an unconventional device such as a PARTIES partition.\r
+  ///\r
   EFI_LEGACY_BIOS_BOOT_UNCONVENTIONAL_DEVICE  BootUnconventionalDevice;\r
 };\r
 \r