[project @ 2002-10-03 13:29:07 by panne]
[ghc-base.git] / System / CPUTime.hsc
index 25098fe..77a8e24 100644 (file)
@@ -1,5 +1,5 @@
 -----------------------------------------------------------------------------
--- 
+-- |
 -- Module      :  System.CPUTime
 -- Copyright   :  (c) The University of Glasgow 2001
 -- License     :  BSD-style (see the file libraries/core/LICENSE)
@@ -8,8 +8,6 @@
 -- Stability   :  provisional
 -- Portability :  portable
 --
--- $Id: CPUTime.hsc,v 1.7 2002/04/24 16:03:39 simonmar Exp $
---
 -- The standard CPUTime library.
 --
 -----------------------------------------------------------------------------
@@ -30,14 +28,10 @@ import Data.Ratio
 #include "HsBase.h"
 
 -- -----------------------------------------------------------------------------
--- Computation `getCPUTime' returns the number of picoseconds CPU time
+-- |Computation 'getCPUTime' returns the number of picoseconds CPU time
 -- used by the current program.  The precision of this result is
 -- implementation-dependent.
 
--- The `cpuTimePrecision' constant is the smallest measurable difference
--- in CPU time that the implementation can record, and is given as an
--- integral number of picoseconds.
-
 getCPUTime :: IO Integer
 getCPUTime = do
 
@@ -113,6 +107,10 @@ foreign import ccall unsafe "GetProcessTimes" getProcessTimes :: Ptr HANDLE -> P
 
 #endif /* not _WIN32 */
 
+-- |The 'cpuTimePrecision' constant is the smallest measurable difference
+-- in CPU time that the implementation can record, and is given as an
+-- integral number of picoseconds.
+
 cpuTimePrecision :: Integer
 cpuTimePrecision = round ((1000000000000::Integer) % fromIntegral (clockTicks))