Clarify @pram b in Base.h. Accepted and edited in Qing Huang changes for @retval...

[mirror_edk2.git] / IntelFrameworkPkg / Include / FrameworkDxe.h

diff --git a/IntelFrameworkPkg/Include/FrameworkDxe.h b/IntelFrameworkPkg/Include/FrameworkDxe.h
index 8b0b0967c1e0e0382b0d1c978d0ba3eaa79a436d..c96c662b3844456f827b8f814a96025de3f45e13 100644 (file)
--- a/IntelFrameworkPkg/Include/FrameworkDxe.h
+++ b/IntelFrameworkPkg/Include/FrameworkDxe.h
@@ -1,26 +1,32 @@
-/** @file
-  Header file that supports Framework extension to UEFI/PI for DXE modules.
-
-  This header file must include Framework extension definitions common to DXE
-  modules.
-
-  Copyright (c) 2007-2009, Intel Corporation
-  All rights reserved. This program and the accompanying materials
-  are licensed and made available under the terms and conditions of the BSD License
-  which accompanies this distribution.  The full text of the license may be found at
-  http://opensource.org/licenses/bsd-license.php
-
-  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
-  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-**/
-
-#ifndef _FRAMEWORK_DXE_H_
-#define _FRAMEWORK_DXE_H_
-
-#include <FrameworkPei.h>
-
-#include <Framework/DxeCis.h>
-
-#include <Framework/FrameworkInternalFormRepresentation.h>
-
-#endif
+/** @file\r
+  The root header file that provides Framework extension to UEFI/PI for modules. It can be included by \r
+  DXE, RUNTIME and SMM type modules which uses Framework definitions.\r
+\r
+\r
+  This header file includes Framework extension definitions common to DXE\r
+  modules.\r
+\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
+  http://opensource.org/licenses/bsd-license.php\r
+\r
+  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
+\r
+#ifndef _FRAMEWORK_DXE_H_\r
+#define _FRAMEWORK_DXE_H_\r
+\r
+#include <PiDxe.h>\r
+\r
+#include <Framework/FrameworkInternalFormRepresentation.h>\r
+#include <Framework/FirmwareVolumeImageFormat.h>\r
+#include <Framework/FirmwareVolumeHeader.h>\r
+#include <Framework/Hob.h>\r
+#include <Framework/BootScript.h>\r
+#include <Framework/StatusCode.h>\r
+#include <Framework/DxeCis.h>\r
+\r
+#endif\r