LIB: various cleanups

src/HSFM/Utils/IO.hs

@@ -1,6 +1,6 @@
 {--
 HSFM, a filemanager written in Haskell.
-Copyright (C) 2015 Julian Ospald
+Copyright (C) 2016 Julian Ospald
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
@@ -18,6 +18,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 
 {-# OPTIONS_HADDOCK ignore-exports #-}
 
+
 -- |Random and general IO utilities.
 module HSFM.Utils.IO where
 
@@ -39,17 +40,23 @@ import Control.Monad
   )
 
 
+-- |Atomically write a TVar.
 writeTVarIO :: TVar a -> a -> IO ()
 writeTVarIO tvar val = atomically $ writeTVar tvar val
 
 
+-- |Atomically modify a TVar.
 modifyTVarIO :: TVar a -> (a -> a) -> IO ()
 modifyTVarIO tvar f = atomically $ modifyTVar tvar f
 
 
+-- |If the value of the first argument is True, then execute the action
+-- provided in the second argument, otherwise do nothing.
 whenM :: Monad m => m Bool -> m () -> m ()
 whenM mb a = mb >>= (`when` a)
 
 
+-- |If the value of the first argument is False, then execute the action
+-- provided in the second argument, otherwise do nothing.
 unlessM :: Monad m => m Bool -> m () -> m ()
 unlessM mb a = mb >>= (`unless` a)

src/HSFM/Utils/MyPrelude.hs

@@ -1,6 +1,6 @@
 {--
 HSFM, a filemanager written in Haskell.
-Copyright (C) 2015 Julian Ospald
+Copyright (C) 2016 Julian Ospald
 
 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
@@ -24,6 +24,9 @@ import Data.List
 
 
 
+-- |Turns any list into a list of the same length with the values
+-- being the indices.
+-- E.g.: "abdasd" -> [0,1,2,3,4,5]
 listIndices :: [a] -> [Int]
 listIndices = findIndices (const True)