fixed wrong comments format.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9019 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2009-07-28 14:24:26 +00:00
parent 5259c97d7a
commit d9fdf2ca96
1 changed files with 97 additions and 43 deletions

View File

@ -23,7 +23,18 @@
// EFI_GRAPHICS_OUTPUT_BLT_PIXEL is defined in MdePkg/Protocol/GraphicsOutput.h
//
#include <Protocol/GraphicsOutput.h>
////// In both EDK and EDK II, incompatbile change is done to Framework HII protocol. /// This change should cause a change of GUID in both of code and HII spec. But we /// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This/// is a known issue.///////// Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII/// 0.92 spec because the spec changed part of HII interfaces but did not update the protocol/// GUID.///#define EFI_HII_PROTOCOL_GUID \
///
/// In both EDK and EDK II, incompatbile change is done to Framework HII protocol.
/// This change should cause a change of GUID in both of code and HII spec. But we
/// update the GUID in code in EDK and EDK II. The 0.92 spec is not updated. This
/// is a known issue.
///
///
/// Note that EFI_HII_PROTOCOL_GUID is different from that defined in the Framework HII
/// 0.92 spec because the spec changed part of HII interfaces but did not update the protocol
/// GUID.
///
#define EFI_HII_PROTOCOL_GUID \
{ \
0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \
}
@ -77,7 +88,11 @@ typedef struct {
UINT16 Type; ///< The type of the package.
} EFI_HII_PACK_HEADER;
////// IFR package structure./// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes. ///typedef struct {
///
/// IFR package structure.
/// Immediately following the EFI_HII_IFR_PACK structure will be a series of IFR opcodes.
///
typedef struct {
EFI_HII_PACK_HEADER Header; ///< Header of the IFR package.
} EFI_HII_IFR_PACK;
@ -85,23 +100,31 @@ typedef struct {
/// HII Handle package structure.
///
typedef struct {
/// /// Header of the package. /// EFI_HII_PACK_HEADER Header; // Must be filled in /// /// The image handle of the driver to which the package is referring. /// EFI_HANDLE ImageHandle; // Must be filled in ///
///
/// Header of the package.
///
EFI_HII_PACK_HEADER Header; ///< Must be filled in
///
/// The image handle of the driver to which the package is referring.
///
EFI_HANDLE ImageHandle; ///< Must be filled in
///
/// The handle of the device that is being described by this package.
///
EFI_HANDLE DeviceHandle; // Optional
EFI_HANDLE DeviceHandle; ///< Optional
///
/// The handle of the parent of the device that is being described by this package.
///
EFI_HANDLE ControllerHandle; // Optional
EFI_HANDLE ControllerHandle; ///< Optional
///
/// The handle that was registered to receive EFI_FORM_CALLBACK_PROTOCOL calls from other drivers.
///
EFI_HANDLE CallbackHandle; // Optional
EFI_HANDLE CallbackHandle; ///< Optional
///
/// Note this field is not defined in the Framework HII 0.92 spec.
/// Unused. Reserved for source code compatibility.
///
EFI_HANDLE COBExportHandle; // Optional
EFI_HANDLE COBExportHandle; ///< Optional
} EFI_HII_HANDLE_PACK;
///
@ -254,7 +277,18 @@ typedef struct {
//
#define LANG_RIGHT_TO_LEFT 0x00000001
////// A string package is used to localize strings to a particular/// language. The package is associated with a particular driver/// or set of drivers. Tools are used to associate tokens with/// string references in forms and in programs. These tokens are/// language agnostic. When paired with a language pack (directly/// or indirectly), the string token resolves into an actual/// UNICODE string. The NumStringPointers determines how many/// StringPointers (offset values) there are as well as the total/// number of Strings that are defined.///typedef struct {
///
/// A string package is used to localize strings to a particular
/// language. The package is associated with a particular driver
/// or set of drivers. Tools are used to associate tokens with
/// string references in forms and in programs. These tokens are
/// language agnostic. When paired with a language pack (directly
/// or indirectly), the string token resolves into an actual
/// UNICODE string. The NumStringPointers determines how many
/// StringPointers (offset values) there are as well as the total
/// number of Strings that are defined.
///
typedef struct {
///
/// Header of the package.
///
@ -306,7 +340,14 @@ typedef struct {
//EFI_WIDE_GLYPH WideGlyphs[];
} EFI_HII_FONT_PACK;
////// The definition of a specific physical key////// Note: Name difference between code and the Framework HII 0.92 spec./// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the/// UEFI 2.1d spec.///typedef struct {
///
/// The definition of a specific physical key
///
/// Note: Name difference between code and the Framework HII 0.92 spec.
/// Add FRAMEWORK_ prefix to avoid name confict with EFI_KEY_DESCRIPTOR defined in the
/// UEFI 2.1d spec.
///
typedef struct {
///
/// Used to describe a physical key on a keyboard.
///
@ -333,7 +374,20 @@ typedef struct {
UINT16 Modifier;
} FRAMEWORK_EFI_KEY_DESCRIPTOR;
////// This structure allows a sparse set of keys to be redefined/// or a complete redefinition of the keyboard layout. Most/// keyboards have a lot of commonality in their layouts, therefore/// only defining those keys that need to change from the default/// minimizes the passed in information.////// Additionally, when an update occurs, the active keyboard layout/// will be switched to the newly updated keyboard layout. This/// allows for situations that when a keyboard layout driver is/// loaded as part of system initialization, the system will default/// the keyboard behavior to the new layout.///typedef struct {
///
/// This structure allows a sparse set of keys to be redefined
/// or a complete redefinition of the keyboard layout. Most
/// keyboards have a lot of commonality in their layouts, therefore
/// only defining those keys that need to change from the default
/// minimizes the passed in information.
///
/// Additionally, when an update occurs, the active keyboard layout
/// will be switched to the newly updated keyboard layout. This
/// allows for situations that when a keyboard layout driver is
/// loaded as part of system initialization, the system will default
/// the keyboard behavior to the new layout.
///
typedef struct {
///
/// Header of the package.
EFI_HII_PACK_HEADER Header;