Modify all file header to follow doxygen format

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

diff --git a/DuetPkg/DataHubGenDxe/DataHubGen.c b/DuetPkg/DataHubGenDxe/DataHubGen.c
index 24b2c636be6e44666e83730cf7f2c149df406cc3..8e59de1c3329b58c6edd28fd65e190d33d2e208b 100644 (file)
--- a/DuetPkg/DataHubGenDxe/DataHubGen.c
+++ b/DuetPkg/DataHubGenDxe/DataHubGen.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -15,7 +15,7 @@ Module Name:
 \r
 Abstract:\r
 \r
---*/\r
+**/\r
 \r
 #include "DataHubGen.h"\r
 \r

diff --git a/DuetPkg/DataHubGenDxe/DataHubGen.h b/DuetPkg/DataHubGenDxe/DataHubGen.h
index 5ac2add1fbdbb120475cd6f548f6c816cd776bdc..593b955eafa64f0cb6105796c9a7765ef850e56d 100644 (file)
--- a/DuetPkg/DataHubGenDxe/DataHubGen.h
+++ b/DuetPkg/DataHubGenDxe/DataHubGen.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -15,7 +15,7 @@ Module Name:
 \r
 Abstract:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _DATA_HUB_GEN_H_\r
 #define _DATA_HUB_GEN_H_\r

diff --git a/DuetPkg/DxeIpl/Debug.c b/DuetPkg/DxeIpl/Debug.c
index c6fcb76132ba68890b0e9fae3c2768229c7e0ec4..45d3a414111d8fc974f06370fc7708d37e796c8e 100644 (file)
--- a/DuetPkg/DxeIpl/Debug.c
+++ b/DuetPkg/DxeIpl/Debug.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "DxeIpl.h"\r
 \r

diff --git a/DuetPkg/DxeIpl/Debug.h b/DuetPkg/DxeIpl/Debug.h
index 9939109e913b3f1f202c6ad86759ff0d0d1d1be4..1bd42179fc8faee63b359e055b8390f901fd0615 100644 (file)
--- a/DuetPkg/DxeIpl/Debug.h
+++ b/DuetPkg/DxeIpl/Debug.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFILDR_DEBUG_H_\r
 #define _EFILDR_DEBUG_H_\r

diff --git a/DuetPkg/DxeIpl/DxeInit.c b/DuetPkg/DxeIpl/DxeInit.c
index 79b6b4c3115e358a99eb96099be9e648f40341fa..2b046c171c491e0f487cf00a25e6f10e5c53a884 100644 (file)
--- a/DuetPkg/DxeIpl/DxeInit.c
+++ b/DuetPkg/DxeIpl/DxeInit.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "DxeIpl.h"\r
 \r

diff --git a/DuetPkg/DxeIpl/HobGeneration.c b/DuetPkg/DxeIpl/HobGeneration.c
index 7630b1e68a7028f83e69ce31c31255307cb39945..bf2fa1a5669b9a8dc2a03527f29786375019facf 100644 (file)
--- a/DuetPkg/DxeIpl/HobGeneration.c
+++ b/DuetPkg/DxeIpl/HobGeneration.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 #include "DxeIpl.h"\r
 #include "HobGeneration.h"\r
 #include "PpisNeededByDxeCore.h"\r

diff --git a/DuetPkg/DxeIpl/HobGeneration.h b/DuetPkg/DxeIpl/HobGeneration.h
index 438e95272b2f4159fda10bcaf313f8130de55673..e6fb9f0057c5f907bffa8f2d8055ad4c6b3173de 100644 (file)
--- a/DuetPkg/DxeIpl/HobGeneration.h
+++ b/DuetPkg/DxeIpl/HobGeneration.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _DXELDR_HOB_GENERATION_H_\r
 #define _DXELDR_HOB_GENERATION_H_\r

diff --git a/DuetPkg/DxeIpl/Ia32/Paging.c b/DuetPkg/DxeIpl/Ia32/Paging.c
index dbc43a3080f383f29bbce02f74c7aa253b2a8a29..ff38dc33c41b853445612eaa0df4f22be73aeed1 100644 (file)
--- a/DuetPkg/DxeIpl/Ia32/Paging.c
+++ b/DuetPkg/DxeIpl/Ia32/Paging.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "DxeIpl.h"\r
 #include "HobGeneration.h"\r

diff --git a/DuetPkg/DxeIpl/Ia32/VirtualMemory.h b/DuetPkg/DxeIpl/Ia32/VirtualMemory.h
index 04eab8f206a9917e79b63608c741737bfa8f945b..81949255e42a059fc9ef38741bc1e1fe3f6ad2b6 100644 (file)
--- a/DuetPkg/DxeIpl/Ia32/VirtualMemory.h
+++ b/DuetPkg/DxeIpl/Ia32/VirtualMemory.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
   \r
 #ifndef _VIRTUAL_MEMORY_H_\r
 #define _VIRTUAL_MEMORY_H_\r

diff --git a/DuetPkg/DxeIpl/LegacyTable.c b/DuetPkg/DxeIpl/LegacyTable.c
index a0fa894e35a5383babb44b835dc34b62ea8166ba..f6f066ed98a7508658169fdde528a5ee083faaab 100644 (file)
--- a/DuetPkg/DxeIpl/LegacyTable.c
+++ b/DuetPkg/DxeIpl/LegacyTable.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "DxeIpl.h"\r
 #include "HobGeneration.h"\r

diff --git a/DuetPkg/DxeIpl/LegacyTable.h b/DuetPkg/DxeIpl/LegacyTable.h
index 77ec756196308bbc3d0308d72fb7cc2d720e5211..6a1b7f8666490e6f0020721b1322d982193c9f45 100644 (file)
--- a/DuetPkg/DxeIpl/LegacyTable.h
+++ b/DuetPkg/DxeIpl/LegacyTable.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _DXELDR_LEGACY_TABLE_H_\r
 #define _DXELDR_LEGACY_TABLE_H_\r

diff --git a/DuetPkg/DxeIpl/PpisNeededByDxeCore.c b/DuetPkg/DxeIpl/PpisNeededByDxeCore.c
index 54f8aa7530b896b21d19e5f9ec87f521d12c92db..a1b9b039891f9e2128461e47fea15903e8ee627e 100644 (file)
--- a/DuetPkg/DxeIpl/PpisNeededByDxeCore.c
+++ b/DuetPkg/DxeIpl/PpisNeededByDxeCore.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
   \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "PpisNeededByDxeCore.h"\r
 #include "HobGeneration.h"\r

diff --git a/DuetPkg/DxeIpl/PpisNeededByDxeCore.h b/DuetPkg/DxeIpl/PpisNeededByDxeCore.h
index 61e9cbec2e3b765d1c78fa0a4cb0671eb5ce26d8..7d9a2e47c84998788f5ac01446d5b0d4200b03d6 100644 (file)
--- a/DuetPkg/DxeIpl/PpisNeededByDxeCore.h
+++ b/DuetPkg/DxeIpl/PpisNeededByDxeCore.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
   \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _DXELDR_PPIS_NEEDED_BY_DXE_CORE_H_\r
 #define _DXELDR_PPIS_NEEDED_BY_DXE_CORE_H_\r

diff --git a/DuetPkg/DxeIpl/SerialStatusCode.c b/DuetPkg/DxeIpl/SerialStatusCode.c
index 20a11d2c54a61fd1fc7cf522e29e1ffcf85c652e..02cc4d47cdd0e6b3942483306c378a7a30503124 100644 (file)
--- a/DuetPkg/DxeIpl/SerialStatusCode.c
+++ b/DuetPkg/DxeIpl/SerialStatusCode.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "SerialStatusCode.h"\r
 \r

diff --git a/DuetPkg/DxeIpl/SerialStatusCode.h b/DuetPkg/DxeIpl/SerialStatusCode.h
index f2e91903bd6d5b5205ff1ba4345eda188fa25d11..3a1b7a9e2b54303ff2e73eb06cc3654e85bde137 100644 (file)
--- a/DuetPkg/DxeIpl/SerialStatusCode.h
+++ b/DuetPkg/DxeIpl/SerialStatusCode.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _DXELDR_SERIAL_STATUS_CODE_H_\r
 #define _DXELDR_SERIAL_STATUS_CODE_H_\r

diff --git a/DuetPkg/DxeIpl/X64/Paging.c b/DuetPkg/DxeIpl/X64/Paging.c
index 0377b6a39b03655508ca105c5a18d5bbbdf75741..436537c42b922d75c5cfa0bb353830672fa3bc9e 100644 (file)
--- a/DuetPkg/DxeIpl/X64/Paging.c
+++ b/DuetPkg/DxeIpl/X64/Paging.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #include "HobGeneration.h"\r
 #include "VirtualMemory.h"\r

diff --git a/DuetPkg/DxeIpl/X64/VirtualMemory.h b/DuetPkg/DxeIpl/X64/VirtualMemory.h
index 6077de513fe7a0f6150229c609499252f8c08194..d32514a44d569189861a212c30d5245ea52d5f13 100644 (file)
--- a/DuetPkg/DxeIpl/X64/VirtualMemory.h
+++ b/DuetPkg/DxeIpl/X64/VirtualMemory.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
   \r
 #ifndef _VIRTUAL_MEMORY_H_\r
 #define _VIRTUAL_MEMORY_H_\r

diff --git a/DuetPkg/Include/CpuIA32.h b/DuetPkg/Include/CpuIA32.h
index 912d128f63b2a34cef4909f78ad9bf3daa0012d7..5b1015b3b60ee9ff87aecb84e988f24a0c9acf5a 100644 (file)
--- a/DuetPkg/Include/CpuIA32.h
+++ b/DuetPkg/Include/CpuIA32.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation. All rights reserved.\r
 This software and associated documentation (if any) is furnished\r
@@ -17,7 +17,7 @@ Abstract:
 \r
   Basic Definition for IA32 Architecture.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _CPU_IA32_H_\r
 #define _CPU_IA32_H_\r

diff --git a/DuetPkg/Include/EfiFlashMap.h b/DuetPkg/Include/EfiFlashMap.h
index 8aa1b98314ee1324a3b38ce5b46a31c5e51921a4..5dfad52205f6bda96abc5344e4fb7969c5c48980 100644 (file)
--- a/DuetPkg/Include/EfiFlashMap.h
+++ b/DuetPkg/Include/EfiFlashMap.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2004 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -17,7 +17,7 @@ Abstract:
 \r
   Defines for the EFI Flash Map functionality\r
   \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_FLASHMAP_H_\r
 #define _EFI_FLASHMAP_H_\r

diff --git a/DuetPkg/Include/EfiLdrHandoff.h b/DuetPkg/Include/EfiLdrHandoff.h
index 69fcd54d4ddf755f730d106c5ff340d4ae2de761..f3b0af132b8d806fbc79c46bbf23eaa4eaf1e9aa 100644 (file)
--- a/DuetPkg/Include/EfiLdrHandoff.h
+++ b/DuetPkg/Include/EfiLdrHandoff.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -16,7 +16,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFILDR_HANDOFF_H_\r
 #define _EFILDR_HANDOFF_H_\r

diff --git a/DuetPkg/Include/FlashLayout.h b/DuetPkg/Include/FlashLayout.h
index 38a3fe4613092b6956cc595869bfcb2b8d84144b..be40e5bd4055494b83d84111112c7b1bcf810918 100644 (file)
--- a/DuetPkg/Include/FlashLayout.h
+++ b/DuetPkg/Include/FlashLayout.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -17,7 +17,7 @@ Abstract:
 \r
   Platform specific flash layout\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_FLASH_LAYOUT\r
 #define _EFI_FLASH_LAYOUT\r

diff --git a/DuetPkg/Include/Guid/AcpiDescription.h b/DuetPkg/Include/Guid/AcpiDescription.h
index 43adf0191bbc0eaa65ea644c997002fc673aa9f9..3c530d51a0ca1a9dc7f31f7a77d6dd486bc7c91f 100644 (file)
--- a/DuetPkg/Include/Guid/AcpiDescription.h
+++ b/DuetPkg/Include/Guid/AcpiDescription.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006 - 2007, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -18,7 +18,7 @@ Abstract:
 \r
    GUIDs used for ACPI Description\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_ACPI_DESCRIPTION_H_\r
 #define _EFI_ACPI_DESCRIPTION_H_\r

diff --git a/DuetPkg/Include/Guid/FlashMapHob.h b/DuetPkg/Include/Guid/FlashMapHob.h
index 1676df2a5e5d58f0a09cd3c38879a5954fc52b94..b1673d2dc5649f3f497b0cc7c15813975b7f2d73 100644 (file)
--- a/DuetPkg/Include/Guid/FlashMapHob.h
+++ b/DuetPkg/Include/Guid/FlashMapHob.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2004, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -17,7 +17,7 @@ Abstract:
 \r
   GUID used for Flash Map HOB entries in the HOB list.\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _FLASH_MAP_HOB_GUID_H_\r
 #define _FLASH_MAP_HOB_GUID_H_\r

diff --git a/DuetPkg/Include/Guid/PciExpressBaseAddress.h b/DuetPkg/Include/Guid/PciExpressBaseAddress.h
index 0625b3e147e0eb21af815ba1e5e2f0ad72604651..957a32da9080c20b07965851fe2ceb88cb50c9c4 100644 (file)
--- a/DuetPkg/Include/Guid/PciExpressBaseAddress.h
+++ b/DuetPkg/Include/Guid/PciExpressBaseAddress.h
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\r
 \r
 Copyright (c) 2006, Intel Corporation                                                         \r
 All rights reserved. This program and the accompanying materials                          \r
@@ -18,7 +18,7 @@ Abstract:
 \r
    GUIDs used for PciExpress Base Address\r
 \r
---*/\r
+**/\r
 \r
 #ifndef _EFI_PCI_EXPRESS_BASE_ADDRESS_H_\r
 #define _EFI_PCI_EXPRESS_BASE_ADDRESS_H_\r