]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/WatchdogTimer.h
Update the copyright notice format
[mirror_edk2.git] / MdePkg / Include / Protocol / WatchdogTimer.h
index 3dc1a587ce304e6c9b452796af35f7f43250ebf2..36ec8599661582aa51e0098390ddc9d69200ec82 100644 (file)
@@ -3,8 +3,8 @@
 \r
   Used to provide system watchdog timer services\r
 \r
-  Copyright (c) 2006 - 2008, Intel Corporation                                                         \r
-  All rights reserved. This program and the accompanying materials                          \r
+  Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR>\r
+  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
   http://opensource.org/licenses/bsd-license.php                                            \r
@@ -121,32 +121,17 @@ EFI_STATUS
   );\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