Add documenation to jumpable
authorMichael Welch <michaelgwelch@gmail.com>
Mon, 20 Feb 2012 15:25:59 +0000 (09:25 -0600)
committerMichael Welch <michaelgwelch@gmail.com>
Mon, 20 Feb 2012 15:25:59 +0000 (09:25 -0600)
haskell/jumpable.hs

index bb9486a..cc1450e 100644 (file)
@@ -1,5 +1,11 @@
--- ! Defines methods for jumping forward and backward on a data structure.
+-- | Defines methods for jumping forward and backward on types that 
+--   keep track of a current state.
 module Jumpable where
+
+-- | Defines jump methods for a data structure that maintains a state.
 class Jumpable a where
+    -- | Jumps the state forward
     jumpF :: a -> a
+
+    -- | Jumps the state backward
     jumpB :: a -> a