Classify: document Types module
commitbf57754328a76dbf200aaeff03abba072d44213d
authorJonathan Daugherty <cygnus@foobox.com>
dateFri 24 Jun 2016, 16:44 (10 years ago)
parent9ce0dca
src/Graphics/Vty/Input/Classify/Types.hs+7
@@ -1,3 +1,5 @@
1+-- | This module exports the input classification type to avoid import
2+-- cycles between other modules that need this.
13module Graphics.Vty.Input.Classify.Types
24 ( KClass(..)
35 ) where
@@ -6,6 +8,11 @@ import Graphics.Vty.Input.Events
68
79data KClass
810 = Valid Event [Char]
11+ -- ^ A valid event was parsed. Any unused characters from the input
12+ -- stream are also provided.
913 | Invalid
14+ -- ^ The input characters did not represent a valid event.
1015 | Prefix
16+ -- ^ The input characters form the prefix of a valid event character
17+ -- sequence.
1118 deriving(Show, Eq)