Fix doxygen issue:

1) comment for structure should be in doxygen format, such as /// , /**, /*!
2) comment for data field of structure should in doxygen format.
3) should not exist blank between ") (" when declaring a type of function point.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5364 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2
2008-06-24 07:14:18 +00:00
parent dc53faa3a2
commit 8b13229b46
98 changed files with 736 additions and 734 deletions

View File

@@ -41,9 +41,9 @@ typedef UINT32 EFI_HII_FONT_STYLE;
#pragma pack(1)
//
// HII package list
//
///
/// HII package list
///
typedef struct {
EFI_GUID PackageListGuid;
UINT32 PackageLength;
@@ -1391,22 +1391,24 @@ typedef struct {
UINT16 AffectedAttribute;
} EFI_KEY_DESCRIPTOR;
//
// A key which is affected by all the standard shift modifiers.
// Most keys would be expected to have this bit active.
//
///
/// A key which is affected by all the standard shift modifiers.
/// Most keys would be expected to have this bit active.
///
#define EFI_AFFECTED_BY_STANDARD_SHIFT 0x0001
//
// This key is affected by the caps lock so that if a keyboard driver
// would need to disambiguate between a key which had a "1" defined
// versus a "a" character. Having this bit turned on would tell
// the keyboard driver to use the appropriate shifted state or not.
//
///
/// This key is affected by the caps lock so that if a keyboard driver
/// would need to disambiguate between a key which had a "1" defined
/// versus a "a" character. Having this bit turned on would tell
/// the keyboard driver to use the appropriate shifted state or not.
///
#define EFI_AFFECTED_BY_CAPS_LOCK 0x0002
//
// Similar to the case of CAPS lock, if this bit is active, the key
// is affected by the num lock being turned on.
//
///
/// Similar to the case of CAPS lock, if this bit is active, the key
/// is affected by the num lock being turned on.
///
#define EFI_AFFECTED_BY_NUM_LOCK 0x0004
typedef struct {
@@ -1493,14 +1495,14 @@ typedef struct {
//
// References to string tokens must use this macro to enable scanning for
// token usages.
//
//
// STRING_TOKEN is not defined in UEFI specification. But it is placed
// here for the easy access by C files and VFR source files.
//
///
/// References to string tokens must use this macro to enable scanning for
/// token usages.
///
///
/// STRING_TOKEN is not defined in UEFI specification. But it is placed
/// here for the easy access by C files and VFR source files.
///
#define STRING_TOKEN(t) t
#endif