Formalize comments for Protocols and PPIs.
1. Use doxygen format for Protocol/PPI data structure 2. Remove doxygen comments for function elements in Protocol/Ppi 3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary 4. PEI Services Table is also updated accordingly. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
@@ -57,21 +57,11 @@ EFI_STATUS
|
||||
IN UINT32 TickNumber
|
||||
);
|
||||
|
||||
/**
|
||||
Interface stucture for the Metronome Architectural Protocol.
|
||||
|
||||
@par Protocol Description:
|
||||
This protocol provides access to a known time source in the platform to the
|
||||
core. The core uses this known time source to produce core services that
|
||||
require calibrated delays.
|
||||
|
||||
@param WaitForTick
|
||||
Waits for a specified number of ticks from a known time source
|
||||
in the platform. The actual time passed between entry of this
|
||||
function and the first tick is between 0 and TickPeriod 100 nS
|
||||
units. If you want to guarantee that at least TickPeriod time
|
||||
has elapsed, wait for two ticks.
|
||||
**/
|
||||
///
|
||||
/// This protocol provides access to a known time source in the platform to the
|
||||
/// core. The core uses this known time source to produce core services that
|
||||
/// require calibrated delays.
|
||||
///
|
||||
struct _EFI_METRONOME_ARCH_PROTOCOL {
|
||||
EFI_METRONOME_WAIT_FOR_TICK WaitForTick;
|
||||
|
||||
|
Reference in New Issue
Block a user