1. Correct File header to ## @file

[mirror_edk2.git] / MdeModulePkg / Universal / Metronome / Metronome.inf

diff --git a/MdeModulePkg/Universal/Metronome/Metronome.inf b/MdeModulePkg/Universal/Metronome/Metronome.inf
index 5dc6227be899dcab61e689b53f2abbe0f0cc0603..d47cfc7ac9bbe1817d5b2072dad4870f54e8a4cb 100644 (file)
--- a/MdeModulePkg/Universal/Metronome/Metronome.inf
+++ b/MdeModulePkg/Universal/Metronome/Metronome.inf
@@ -1,8 +1,17 @@
-#/** @file\r
-# This module produces the Metronome Architectural Protocol on top of an instance\r
-# of the Timer Library defined in the MdePkg.\r
+## @file\r
+# This module produces the Metronome Architectural Protocol on top of Timer Library.\r
 #\r
-# Copyright (c) 2008, Intel Corporation                                                         \r
+# This is a generic implementation of the Metronome Architectural Protocol that\r
+# layers on top of an instance of the Timer Library.  The Timer Library provides\r
+# functions for nanosecond and microsecond delays.  This generic implementation\r
+# produces a fixed TickPeriod of 100ns unit, and when the WaitForTick() service\r
+# is called, the number of ticks passed in is converted to either nanosecond or\r
+# microsecond units.  If the number of ticks is small, then nanoseconds are used.\r
+# If the number of ticks is large, then microseconds are used.  This prevents\r
+# overflows that could occur for long delays if only nanoseconds were used and also\r
+# provides the greatest accuracy for small delays. \r
+#\r
+# Copyright (c) 2008 - 2010, 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,7 +20,7 @@
 # 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
-#**/\r
+##\r
 \r
 [Defines]\r
   INF_VERSION                    = 0x00010005\r
@@ -36,12 +45,12 @@
   TimerLib\r
   DebugLib\r
 \r
-[Sources.common]\r
+[Sources]\r
   Metronome.c\r
   Metronome.h\r
 \r
 [Protocols]\r
-  gEfiMetronomeArchProtocolGuid\r
+  gEfiMetronomeArchProtocolGuid      ## PRODUCES\r
 \r
 [Depex]\r
   TRUE\r