Correct the structure's comments to follow doxygen format.

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

diff --git a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
index 09a8dcb524dd040ab3678c83e8f94c1822ce22e7..0b3ab83b9d5c4dc7ca3cda2c46bedbbcb4ededbe 100644 (file)
--- a/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
+++ b/IntelFrameworkPkg/Include/Protocol/LegacyRegion.h
@@ -1,7 +1,7 @@
 /** @file\r
   This protocol manages the legacy memory regions between 0xc0000 - 0xfffff\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
@@ -112,29 +112,15 @@ EFI_STATUS
   );\r
 \r
 /**\r
-  @par Protocol Description:\r
   Abstracts the hardware control of the physical address region 0xC0000-C0xFFFFF\r
   for the traditional BIOS.\r
-\r
-  @param Decode\r
-  Specifies a region for the chipset to decode\r
-\r
-  @param Lock\r
-  Makes the specified OpROM region read only or locked.\r
-\r
-  @param BootLock\r
-  Sets a region to read only and ensures tat flash is locked from\r
-  inadvertent modification.\r
-\r
-  @param Unlock\r
-  Makes the specified OpROM region read-write or unlocked.\r
-\r
 **/\r
 struct _EFI_LEGACY_REGION_PROTOCOL {\r
-  EFI_LEGACY_REGION_DECODE    Decode;\r
-  EFI_LEGACY_REGION_LOCK      Lock;\r
-  EFI_LEGACY_REGION_BOOT_LOCK BootLock;\r
-  EFI_LEGACY_REGION_UNLOCK    UnLock;\r
+  EFI_LEGACY_REGION_DECODE    Decode;     ///< Specifies a region for the chipset to decode\r
+  EFI_LEGACY_REGION_LOCK      Lock;       ///< Makes the specified OpROM region read only or locked.\r
+  EFI_LEGACY_REGION_BOOT_LOCK BootLock;   ///< Sets a region to read only and ensures tat flash is locked from\r
+                                          ///< inadvertent modification.\r
+  EFI_LEGACY_REGION_UNLOCK    UnLock;     ///< Makes the specified OpROM region read-write or unlocked.\r
 };\r
 \r
 extern EFI_GUID gEfiLegacyRegionProtocolGuid;\r