summaryrefslogtreecommitdiff
path: root/src/compiler/GF/Infra/UseIO.hs
diff options
context:
space:
mode:
authorhallgren <hallgren@chalmers.se>2014-11-10 15:23:02 +0000
committerhallgren <hallgren@chalmers.se>2014-11-10 15:23:02 +0000
commit33571ba44f2a42502722a3b025b448efe1f0ab88 (patch)
tree7a34727f7cf11a0bb9e1b2cee1a0b785ae71240c /src/compiler/GF/Infra/UseIO.hs
parentcabafd68a66c05478ecdd301ed9cf1564c57a3c5 (diff)
Some work to improve the structure of the haddock documenation
Diffstat (limited to 'src/compiler/GF/Infra/UseIO.hs')
-rw-r--r--src/compiler/GF/Infra/UseIO.hs15
1 files changed, 8 insertions, 7 deletions
diff --git a/src/compiler/GF/Infra/UseIO.hs b/src/compiler/GF/Infra/UseIO.hs
index b9ff9c2e5..b5ef38f49 100644
--- a/src/compiler/GF/Infra/UseIO.hs
+++ b/src/compiler/GF/Infra/UseIO.hs
@@ -12,8 +12,9 @@
-- (Description of the module)
-----------------------------------------------------------------------------
-module GF.Infra.UseIO(module GF.Infra.UseIO,
- -- ** Reused
+module GF.Infra.UseIO(-- ** Files and IO
+ module GF.Infra.UseIO,
+ -- *** Reused
MonadIO(..),liftErr) where
import Prelude hiding (catch)
@@ -40,7 +41,7 @@ import Control.Exception(evaluate)
--putIfVerb :: MonadIO io => Options -> String -> io ()
putIfVerb opts msg = when (verbAtLeast opts Verbose) $ putStrLnE msg
--- ** GF files path and library path manipulation
+-- *** GF files path and library path manipulation
type FileName = String
type InitPath = String -- ^ the directory portion of a pathname
@@ -123,7 +124,7 @@ splitInModuleSearchPath s = case break isPathSep s of
--
--- ** IO monad with error; adapted from state monad
+-- *** Error handling in the IO monad
-- | Was: @newtype IOE a = IOE { appIOE :: IO (Err a) }@
type IOE a = IO a
@@ -177,7 +178,7 @@ die :: String -> IO a
die s = do hPutStrLn stderr s
exitFailure
--- ** Diagnostic output
+-- *** Diagnostic output
class Monad m => Output m where
ePutStr, ePutStrLn, putStrE, putStrLnE :: String -> m ()
@@ -215,7 +216,7 @@ ioErrorText e = if isUserError e
then ioeGetErrorString e
else show e
--- ** Timing
+-- *** Timing
timeIt act =
do t1 <- liftIO $ getCPUTime
@@ -223,7 +224,7 @@ timeIt act =
t2 <- liftIO $ getCPUTime
return (t2-t1,a)
--- ** File IO
+-- *** File IO
writeUTF8File :: FilePath -> String -> IO ()
writeUTF8File fpath content =