Correct definition to follow spec.

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

diff --git a/MdePkg/Include/Protocol/Timer.h b/MdePkg/Include/Protocol/Timer.h
index 55ea8805342576fd9e3212493dd985f2fc000204..6fe0044b87bbe66fea39a487a39ffbc6d8ad70b7 100644 (file)
--- a/MdePkg/Include/Protocol/Timer.h
+++ b/MdePkg/Include/Protocol/Timer.h
@@ -3,8 +3,8 @@
 \r
   This code is used to provide the timer tick for the DXE core.\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
@@ -160,40 +160,14 @@ EFI_STATUS
   );\r
 \r
 \r
-/**\r
-  Interface stucture for the Timer Architectural Protocol.\r
-\r
-  @par Protocol Description:\r
-  This protocol provides the services to initialize a periodic timer \r
-  interrupt, and to register a handler that is called each time the timer\r
-  interrupt fires.  It may also provide a service to adjust the rate of the\r
-  periodic timer interrupt.  When a timer interrupt occurs, the handler is \r
-  passed the amount of time that has passed since the previous timer \r
-  interrupt.\r
-\r
-  @param RegisterHandler\r
-  Registers a handler that will be called each time the \r
-  timer interrupt fires.  TimerPeriod defines the minimum \r
-  time between timer interrupts, so TimerPeriod will also \r
-  be the minimum time between calls to the registered \r
-  handler.\r
-\r
-  @param SetTimerPeriod\r
-  Sets the period of the timer interrupt in 100 nS units.  \r
-  This function is optional, and may return EFI_UNSUPPORTED.  \r
-  If this function is supported, then the timer period will \r
-  be rounded up to the nearest supported timer period.\r
-\r
-  @param GetTimerPeriod\r
-  Retrieves the period of the timer interrupt in 100 nS units.\r
-\r
-  @param GenerateSoftInterrupt\r
-  Generates a soft timer interrupt that simulates the firing of \r
-  the timer interrupt. This service can be used to invoke the \r
-  registered handler if the timer interrupt has been masked for \r
-  a period of time.\r
-\r
-**/\r
+///\r
+/// This protocol provides the services to initialize a periodic timer \r
+/// interrupt, and to register a handler that is called each time the timer\r
+/// interrupt fires.  It may also provide a service to adjust the rate of the\r
+/// periodic timer interrupt.  When a timer interrupt occurs, the handler is \r
+/// passed the amount of time that has passed since the previous timer \r
+/// interrupt.\r
+///\r
 struct _EFI_TIMER_ARCH_PROTOCOL {\r
   EFI_TIMER_REGISTER_HANDLER          RegisterHandler;\r
   EFI_TIMER_SET_TIMER_PERIOD          SetTimerPeriod;\r