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:
xli24
2008-10-13 02:54:29 +00:00
parent 66eebcf94f
commit 44717a398f
103 changed files with 576 additions and 1012 deletions

View File

@@ -121,20 +121,17 @@ EFI_STATUS
);
/**
Interface stucture for the Watchdog Timer Architectural Protocol.
@par Protocol Description:
This protocol provides the services required to implement the Boot Service
SetWatchdogTimer(). It provides a service to set the amount of time to wait
before firing the watchdog timer, and it also provides a service to register
a handler that is invoked when the watchdog timer fires. This protocol can
implement the watchdog timer by using the event and timer Boot Services, or
it can make use of custom hardware. When the watchdog timer fires, control
will be passed to a handler if one has been registered. If no handler has
been registered, or the registered handler returns, then the system will be
reset by calling the Runtime Service ResetSystem().
**/
///
/// This protocol provides the services required to implement the Boot Service
/// SetWatchdogTimer(). It provides a service to set the amount of time to wait
/// before firing the watchdog timer, and it also provides a service to register
/// a handler that is invoked when the watchdog timer fires. This protocol can
/// implement the watchdog timer by using the event and timer Boot Services, or
/// it can make use of custom hardware. When the watchdog timer fires, control
/// will be passed to a handler if one has been registered. If no handler has
/// been registered, or the registered handler returns, then the system will be
/// reset by calling the Runtime Service ResetSystem().
///
struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {
EFI_WATCHDOG_TIMER_REGISTER_HANDLER RegisterHandler;
EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD SetTimerPeriod;