tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen comment for structure and macro 

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6095 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-10-09 18:33:40 +00:00
parent a4e0b060c6
commit 721b16af11
11 changed files with 29 additions and 211 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
MdePkg/Include/Protocol/GuidedSectionExtraction.h
View File

@ -133,10 +133,6 @@ EFI_STATUS
of the GUIDed Section Extraction Protocol must have the same interface structure, they do not all
have the same GUID. The GUID that is associated with an instance of the GUIDed Section
Extraction Protocol is used to correlate it with the GUIDed section type that it is intended to process.
@param ExtractSection
Takes the GUIDed section as input and produces the section stream data.
**/
struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL {
EFI_EXTRACT_GUIDED_SECTION ExtractSection;

7
MdePkg/Include/Protocol/Hash.h
View File

@ -132,13 +132,6 @@ EFI_STATUS
@par Protocol Description:
This protocol allows creating a hash of an arbitrary message digest
using one or more hash algorithms.
@param GetHashSize
Return the size of a specific type of resulting hash.
@param Hash
Create a hash for the specified message.
**/
struct _EFI_HASH_PROTOCOL {
EFI_HASH_GET_HASH_SIZE GetHashSize;

16
MdePkg/Include/Protocol/HiiConfigAccess.h
View File

@ -198,26 +198,12 @@ EFI_STATUS
OUT EFI_BROWSER_ACTION_REQUEST *ActionRequest
)
;
/**
@par Protocol Description:
This protocol provides a callable interface between the HII and
drivers. Only drivers which provide IFR data to HII are required
to publish this protocol.
@param ExtractConfig This function breaks apart the UNICODE
request strings routing them to the
appropriate drivers. This function is
analogous to the similarly named
function in the HII Routing Protocol.
@param RouteConfig This function breaks apart the UNICODE
results strings and returns configuration
information as specified by the request.
@param Callback This function is called from the
configuration browser to communicate certain
activities that were initiated by a user.
**/
struct _EFI_HII_CONFIG_ACCESS_PROTOCOL {
EFI_HII_ACCESS_EXTRACT_CONFIG ExtractConfig;

27
MdePkg/Include/Protocol/HiiConfigRouting.h
View File

@ -25,7 +25,6 @@
typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;
/**
This function allows the caller to request the current
@ -396,32 +395,6 @@ EFI_STATUS
This protocol defines the configuration routing interfaces
between external applications and the HII. There may only be one
instance of this protocol in the system.
@param ExtractConfig
This function allows a caller to extract the current configuration for
one or more named elements from one or more drivers.
@param ExportConfig
This function allows the caller to request the current configuration for
the entirety of the current HII database and returns the data
in a null-terminated Unicode string.
@param RouteConfig
This function processes the results of processing forms and routes it
to the appropriate handlers or storage.
@param BlockToConfig
This helper function is to be called by drivers to map configuration data
stored in byte array ("block") formats such as UEFI Variables into current
configuration strings.
@param ConfigToBlock
This helper function is to be called by drivers to map configuration strings
to configurations stored in byte array ("block") formats such as UEFI Variables.
@param GetAltConfig
This helper function is to be called by drivers to extract portions of a larger configuration string.
**/
struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {
EFI_HII_ROUTING_EXTRACT_CONFIG ExtractConfig;

47
MdePkg/Include/Protocol/HiiDatabase.h
View File

@ -23,10 +23,11 @@
typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;
//
// EFI_HII_DATABASE_NOTIFY_TYPE
//
///
/// EFI_HII_DATABASE_NOTIFY_TYPE
///
typedef UINTN EFI_HII_DATABASE_NOTIFY_TYPE;
#define EFI_HII_DATABASE_NOTIFY_NEW_PACK 0x00000001
#define EFI_HII_DATABASE_NOTIFY_REMOVE_PACK 0x00000002
#define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004
@ -493,46 +494,10 @@ EFI_STATUS
/**
@par Protocol Description:
Database manager for HII-related data structures.
@param NewPackageList Add a new package list to the HII database.
@param RemovePackageList Remove a package list from the HII
database.
@param UpdatePackageList Update a package list in the HII
database.
@param ListPackageLists List the handles of the package
lists within the HII database.
@param ExportPackageLists Export package lists from the HII
database.
@param RegisterPackageNotify
Register notification when
packages of a certain type are
installed.
@param UnregisterPackageNotify
Unregister notification of packages.
@param FindKeyboardLayouts
Retrieves a list of the keyboard
layouts in the system.
@param GetKeyboardLayout Allows a program to extract the
current keyboard layout. See the
GetKeyboardLayout() function
description.
@param SetKeyboardLayout Changes the current keyboard layout.
See the SetKeyboardLayout() function
**/
struct _EFI_HII_DATABASE_PROTOCOL {
EFI_HII_DATABASE_NEW_PACK NewPackageList;
EFI_HII_DATABASE_REMOVE_PACK RemovePackageList;
EFI_HII_DATABASE_NEW_PACK NewPackageList;
EFI_HII_DATABASE_REMOVE_PACK RemovePackageList;
EFI_HII_DATABASE_UPDATE_PACK UpdatePackageList;
EFI_HII_DATABASE_LIST_PACKS ListPackageLists;
EFI_HII_DATABASE_EXPORT_PACKS ExportPackageLists;

74
MdePkg/Include/Protocol/HiiFont.h
View File

@ -25,10 +25,11 @@ typedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;
typedef VOID *EFI_FONT_HANDLE;
//
// EFI_HII_OUT_FLAGS
//
///
/// EFI_HII_OUT_FLAGS
///
typedef UINT32 EFI_HII_OUT_FLAGS;
#define EFI_HII_OUT_FLAG_CLIP 0x00000001
#define EFI_HII_OUT_FLAG_WRAP 0x00000002
#define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004
@ -39,38 +40,32 @@ typedef UINT32 EFI_HII_OUT_FLAGS;
#define EFI_HII_DIRECT_TO_SCREEN 0x00000080
/**
Definition of EFI_HII_ROW_INFO.
@param StartIndex The index of the first character in the
string which is displayed on the line.
@param EndIndex The index of the last character in the string
which is displayed on the line. If this is the
same as StartIndex, then no characters are
displayed.
@param LineHeight The height of the line, in pixels.
@param LineWidth The width of the text on the line, in pixels.
@param BaselineOffset The number of pixels above the bottom of
the row of the font baseline or 0 if
none.
**/
typedef struct _EFI_HII_ROW_INFO {
///
/// The index of the first character in the string which is displayed on the line.
///
UINTN StartIndex;
///
/// The index of the last character in the string which is displayed on the line.
/// If this is the same as StartIndex, then no characters are displayed.
///
UINTN EndIndex;
UINTN LineHeight;
UINTN LineWidth;
UINTN LineHeight; ///< The height of the line, in pixels.
UINTN LineWidth; ///< The width of the text on the line, in pixels.
///
/// The number of pixels above the bottom of the row of the font baseline or 0 if none.
///
UINTN BaselineOffset;
} EFI_HII_ROW_INFO;
//
// EFI_FONT_INFO_MASK
//
///
/// EFI_FONT_INFO_MASK
///
typedef UINT32 EFI_FONT_INFO_MASK;
#define EFI_FONT_INFO_SYS_FONT 0x00000001
#define EFI_FONT_INFO_SYS_SIZE 0x00000002
#define EFI_FONT_INFO_SYS_STYLE 0x00000004
@ -87,7 +82,7 @@ typedef UINT32 EFI_FONT_INFO_MASK;
//
typedef struct {
EFI_HII_FONT_STYLE FontStyle;
UINT16 FontSize; // character cell height in pixels
UINT16 FontSize; ///< character cell height in pixels
CHAR16 FontName[1];
} EFI_FONT_INFO;
@ -127,22 +122,6 @@ typedef struct {
EFI_FONT_INFO_ANY_STYLE is specified, then the system may
attempt to match with any font style. This flag cannot be used
with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.
@param ForegroundColor The color of the "on" pixels in the
glyph in the bitmap.
@param BackgroundColor The color of the "off" pixels in the
glyph in the bitmap.
@param FontInfoMask The font information mask determines
which portion of the font information
will be used and what to do if the
specific font is not available.
@param FontInfo Points to the font information or NULL if the
string should use the default system font.
**/
typedef struct _EFI_FONT_DISPLAY_INFO {
EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;
@ -503,15 +482,6 @@ EFI_STATUS
/**
@par Protocol Description:
The protocol provides the service to retrieve the font informations.
@param StringToImage Render a string to a bitmap or to the display.
@param StringIdToImage Render a string to a bitmap or to the display.
@param GetGlyph Return a specific glyph in a specific font.
@param GetFontInfo Return font information for a specific font.
**/
struct _EFI_HII_FONT_PROTOCOL {
EFI_HII_STRING_TO_IMAGE StringToImage;

13
MdePkg/Include/Protocol/HiiImage.h
View File

@ -339,19 +339,6 @@ IN UINTN BltY
/**
@par Protocol Description:
Services to access to images in the images database.
@param NewImage Add a new image.
@param GetImage Retrieve an image and related font
information.
@param SetImage Change an image.
@param DrawImage Renders an image to a bitmap or to the display.
@param DrawImageId Render an image to a bitmap or the screen containing
the contents of the specified image.
**/
struct _EFI_HII_IMAGE_PROTOCOL {
EFI_HII_NEW_IMAGE NewImage;

13
MdePkg/Include/Protocol/HiiString.h
View File

@ -217,19 +217,6 @@ EFI_STATUS
/**
@par Protocol Description:
Services to manipulate the string.
@param NewString Add a new string. GetString Retrieve a
string and related string information.
@param SetString Change a string.
@param GetLanguages List the languages for a particular
package list.
@param GetSecondaryLanguages List supported secondary
languages for a particular
primary language.
**/
struct _EFI_HII_STRING_PROTOCOL {
EFI_HII_NEW_STRING NewString;

5
MdePkg/Include/Protocol/IScsiInitiatorName.h
View File

@ -74,11 +74,6 @@ typedef EFI_STATUS
/**
@par Protocol Description:
iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name.
@param Get Used to retrieve the iSCSI Initiator Name.
@param Set Used to set the iSCSI Initiator Name.
**/
struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL {
EFI_ISCSI_INITIATOR_NAME_GET Get;

24
MdePkg/Include/Protocol/Ip4.h
View File

@ -398,30 +398,6 @@ EFI_STATUS
@par Protocol Description:
The EFI IPv4 Protocol implements a simple packet-oriented interface that can be
used by drivers, daemons, and applications to transmit and receive network packets.
@param GetModeData
Gets the current operational settings for this instance of the EFI IPv4 Protocol driver.
@param Configure
Changes or resets the operational settings for the EFI IPv4 Protocol.
@param Groups
Joins and leaves multicast groups.
@param Routes
Adds and deletes routing table entries.
@param Transmit
Places outgoing data packets into the transmit queue.
@param Receive
Places a receiving request into the receiving queue.
@param Cancel
Aborts a pending transmit or receive request.
@param Poll
Polls for incoming data packets and processes outgoing data packets.
**/
struct _EFI_IP4_PROTOCOL {
EFI_IP4_GET_MODE_DATA GetModeData;

10
MdePkg/Include/Protocol/Ip4Config.h
View File

@ -114,16 +114,6 @@ EFI_STATUS
@par Protocol Description:
The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent
configuration for the EFI IPv4 Protocol driver.
@param Start
Starts running the configuration policy for the EFI IPv4 Protocol driver.
@param Stop
Stops running the configuration policy for the EFI IPv4 Protocol driver.
@param GetData
Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.
**/
struct _EFI_IP4_CONFIG_PROTOCOL {
EFI_IP4_CONFIG_START Start;