[Pkg-haskell-commits] [SCM] haskell-testpack branch, master, updated. debian/1.0.2-1-4-gb0d6b36

[John Goerzen]

The following commit has been merged in the master branch:
commit 4cbad8f58807de974ca3a22196e55ccf146c4f32
Author: John Goerzen <jgoerzen at complete.org>
Date:   Wed Nov 29 01:46:35 2006 +0100

    Properly list ProgressMeter exports

diff --git a/MissingH/ProgressMeter.hs b/MissingH/ProgressMeter.hs
index 0ea9fab..851b180 100644
--- a/MissingH/ProgressMeter.hs
+++ b/MissingH/ProgressMeter.hs
@@ -30,10 +30,25 @@ as a layer atop "MissingH.ProgressTracker".
 
 Written by John Goerzen, jgoerzen\@complete.org -}
 
-module MissingH.ProgressMeter 
+module MissingH.ProgressMeter (-- * Types
+                               ProgressMeter,
+                               -- * Creation and Configuration
+                               simpleNewMeter,
+                               newMeter,
+                               setComponents,
+                               addComponent,
+                               removeComponent,
+                               setWidth,
+                               
+                               -- * Rendering and Output
+                               renderMeter,
+                               displayMeter,
+                               clearMeter,
+                               writeMeterString,
+                               autoDisplayMeter,
+                               killAutoDisplayMeter
+                               ) where
 
-
-where
 import MissingH.ProgressTracker
 import Control.Concurrent.MVar
 import Control.Concurrent
@@ -44,13 +59,15 @@ import MissingH.Quantity
 import System.IO
 import Control.Monad(filterM)
 
+{- | The main data type for the progress meter. -}
 data ProgressMeterR = 
-    ProgressMeterR {masterP :: Progress,
-                    components :: [Progress],
-                    width :: Int,
-                    unit :: String,
-                    renderer :: Integer -> String,
-                    autoDisplayers :: [ThreadId]}
+    ProgressMeterR {masterP :: Progress, -- ^ The master 'Progress' object for overall status
+                    components :: [Progress], -- ^ Individual component statuses
+                    width :: Int, -- ^ Width of the meter
+                    unit :: String, -- ^ Units of display
+                    renderer :: Integer -> String, -- ^ Function to render
+                    autoDisplayers :: [ThreadId] -- ^ Auto-updating display
+                   }
 
 type ProgressMeter = MVar ProgressMeterR
 

-- 
haskell-testpack