update codes per MdePkg doxgen review comments.

[mirror_edk2.git] / MdePkg / Include / Protocol / WatchdogTimer.h

diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h
index 4cf2411bdd59b13c63c3a5535246ca6692bc0d94..27278620387d26e1afbc4ccfb9fd48dcdd1f86f5 100644 (file)
--- a/MdePkg/Include/Protocol/WatchdogTimer.h
+++ b/MdePkg/Include/Protocol/WatchdogTimer.h
@@ -1,9 +1,9 @@
 /** @file\r
-  Watchdog Timer Architectural Protocol as defined in the DXE CIS\r
+  Watchdog Timer Architectural Protocol as defined in PI Specification VOLUME 2 DXE\r
 \r
   Used to provide system watchdog timer services\r
 \r
-  Copyright (c) 2006, Intel Corporation                                                         \r
+  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r
   which accompanies this distribution.  The full text of the license may be found at        \r
@@ -11,24 +11,20 @@
 \r
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
-\r
-  @par Revision Reference:\r
-  Version 0.91B.\r
-\r
 **/\r
 \r
 #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 #define __ARCH_PROTOCOL_WATCHDOG_TIMER_H__\r
 \r
-//\r
-// Global ID for the Watchdog Timer Architectural Protocol\r
-//\r
+///\r
+/// Global ID for the Watchdog Timer Architectural Protocol\r
+///\r
 #define EFI_WATCHDOG_TIMER_ARCH_PROTOCOL_GUID \\r
   { 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } }\r
 \r
-//\r
-// Declare forward reference for the Timer Architectural Protocol\r
-//\r
+///\r
+/// Declare forward reference for the Timer Architectural Protocol\r
+///\r
 typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOCOL;\r
 \r
 /**\r
@@ -44,7 +40,7 @@ typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  EFI_WATCHDOG_TIMER_ARCH_PROTOC
 **/\r
 typedef\r
 VOID\r
-(EFIAPI *EFI_WATCHDOG_TIMER_NOTIFY) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_NOTIFY)(\r
   IN UINT64  Time\r
   );\r
 \r
@@ -74,7 +70,7 @@ VOID
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_REGISTER_HANDLER)(\r
   IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   IN EFI_WATCHDOG_TIMER_NOTIFY         NotifyFunction\r
   );\r
@@ -97,7 +93,7 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD)(\r
   IN EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   IN UINT64                            TimerPeriod\r
   );\r
@@ -119,38 +115,23 @@ EFI_STATUS
 **/\r
 typedef \r
 EFI_STATUS\r
-(EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD) (\r
+(EFIAPI *EFI_WATCHDOG_TIMER_GET_TIMER_PERIOD)(\r
   IN  EFI_WATCHDOG_TIMER_ARCH_PROTOCOL  *This,\r
   OUT UINT64                            *TimerPeriod\r
   );\r
 \r
 \r
-/**\r
-  Interface stucture for the Watchdog Timer Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  This protocol provides the services required to implement the Boot Service \r
-  SetWatchdogTimer().  It provides a service to set the amount of time to wait \r
-  before firing the watchdog timer, and it also provides a service to register \r
-  a handler that is invoked when the watchdog timer fires.  This protocol can \r
-  implement the watchdog timer by using the event and timer Boot Services, or \r
-  it can make use of custom hardware.  When the watchdog timer fires, control \r
-  will be passed to a handler if one has been registered.  If no handler has \r
-  been registered, or the registered handler returns, then the system will be \r
-  reset by calling the Runtime Service ResetSystem().\r
-\r
-  @param  RegisterHandler  Registers a handler that is invoked when the watchdog\r
-                           timer fires.\r
-\r
-  @param  SetTimerPeriod   Sets the amount of time in 100 ns units to wait before the\r
-                           watchdog timer is fired. If this function is supported,\r
-                           then the watchdog timer period will be rounded up to the\r
-                           nearest supported watchdog timer period.\r
-\r
-  @param  GetTimerPeriod   Retrieves the amount of time in 100 ns units that the\r
-                           system will wait before the watchdog timer is fired.\r
-\r
-**/\r
+///\r
+/// This protocol provides the services required to implement the Boot Service \r
+/// SetWatchdogTimer().  It provides a service to set the amount of time to wait \r
+/// before firing the watchdog timer, and it also provides a service to register \r
+/// a handler that is invoked when the watchdog timer fires.  This protocol can \r
+/// implement the watchdog timer by using the event and timer Boot Services, or \r
+/// it can make use of custom hardware.  When the watchdog timer fires, control \r
+/// will be passed to a handler if one has been registered.  If no handler has \r
+/// been registered, or the registered handler returns, then the system will be \r
+/// reset by calling the Runtime Service ResetSystem().\r
+///\r
 struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL {\r
   EFI_WATCHDOG_TIMER_REGISTER_HANDLER  RegisterHandler;\r
   EFI_WATCHDOG_TIMER_SET_TIMER_PERIOD  SetTimerPeriod;\r