Use doxygen comment style for document entity such as struct, enum, variable that...

[mirror_edk2.git] / MdePkg / Include / Library / TimerLib.h

diff --git a/MdePkg/Include/Library/TimerLib.h b/MdePkg/Include/Library/TimerLib.h
index 8523bd0dfbafbe4b02aba9b40d1bc9b8ad662bf9..3959396e205f5729fe42a2a10c6f25103627469a 100644 (file)
--- a/MdePkg/Include/Library/TimerLib.h
+++ b/MdePkg/Include/Library/TimerLib.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Timer Library Functions\r
+  Timer Library Functions.\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
@@ -10,16 +10,12 @@
   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
-  Module Name:  TimerLib.h\r
-\r
 **/\r
 \r
 #ifndef __TIMER_LIB__\r
 #define __TIMER_LIB__\r
 \r
 /**\r
-  Stalls the CPU for at least the given number of microseconds.\r
-\r
   Stalls the CPU for the number of microseconds specified by MicroSeconds.\r
 \r
   @param  MicroSeconds  The minimum number of microseconds to delay.\r
@@ -34,8 +30,6 @@ MicroSecondDelay (
   );\r
 \r
 /**\r
-  Stalls the CPU for at least the given number of nanoseconds.\r
-\r
   Stalls the CPU for the number of nanoseconds specified by NanoSeconds.\r
 \r
   @param  NanoSeconds The minimum number of nanoseconds to delay.\r
@@ -50,10 +44,8 @@ NanoSecondDelay (
   );\r
 \r
 /**\r
-  Retrieves the current value of a 64-bit free running performance counter.\r
-\r
-  Retrieves the current value of a 64-bit free running performance counter. The\r
-  counter can either count up by 1 or count down by 1. If the physical\r
+  Retrieves the current value of a 64-bit free running performance counter. \r
+  The counter can either count up by 1 or count down by 1. If the physical\r
   performance counter counts by a larger increment, then the counter values\r
   must be translated. The properties of the counter can be retrieved from\r
   GetPerformanceCounterProperties().\r
@@ -93,8 +85,8 @@ GetPerformanceCounter (
 UINT64\r
 EFIAPI\r
 GetPerformanceCounterProperties (\r
-  IN      UINT64                    *StartValue,  OPTIONAL\r
-  IN      UINT64                    *EndValue     OPTIONAL\r
+  OUT      UINT64                    *StartValue,  OPTIONAL\r
+  OUT      UINT64                    *EndValue     OPTIONAL\r
   );\r
 \r
 #endif\r