on master help sign in
Classify: document Types module
bf57754Jonathan Daugherty
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.
1module Graphics.Vty.Input.Classify.Types
3module Graphics.Vty.Input.Classify.Types
2 ( KClass(..)
4 ( KClass(..)
3 ) where
5 ) where
@@ -6,6 +8,11 @@ import Graphics.Vty.Input.Events
6
8
7data KClass
9data KClass
8 = Valid Event [Char]
10 = Valid Event [Char]
11+ -- ^ A valid event was parsed. Any unused characters from the input
12+ -- stream are also provided.
9 | Invalid
13 | Invalid
14+ -- ^ The input characters did not represent a valid event.
10 | Prefix
15 | Prefix
16+ -- ^ The input characters form the prefix of a valid event character
17+ -- sequence.
11 deriving(Show, Eq)
18 deriving(Show, Eq)