Introduce Main module, get doc coverage to 100%

Exported modules:

* Text.Emoji
* Text.Emoji.Data

6 files changed, 52 insertions, 10 deletions

diff --git a/emoji.cabal b/emoji.cabal
index f1045a8..0294a54 100644
--- a/emoji.cabal
+++ b/emoji.cabal
@@ -16,11 +16,8 @@ build-type:          Simple
 cabal-version:       >=1.10
 
 library
-  exposed-modules:     Text.Emoji.Types
+  exposed-modules:     Text.Emoji
                      , Text.Emoji.Data
-                     , Text.Emoji.String
-                     , Text.Emoji.Text
-                     , Text.Emoji.Emojis
   -- other-modules:       
   -- other-extensions:    
   build-depends:       base
diff --git a/src/Text/Emoji.hs b/src/Text/Emoji.hs
new file mode 100644
index 0000000..c1e50db
--- /dev/null
+++ b/src/Text/Emoji.hs
@@ -0,0 +1,22 @@
+{-|
+    Module: Text.Emoji
+    Description: Main module of the emoji library
+
+Library for querying information about emojis, filtering and displaying emojis.
+-}
+module Text.Emoji
+  ( emojiData
+  , emojiToString
+  , emojiToText
+  , EmojiStyle (..)
+  , EmojiLevel (..)
+  , EmojiModifierStatus (..)
+  , EmojiSource (..)
+  , EmojiSources (..)
+  , Emoji (..)
+  ) where
+
+import Text.Emoji.Emojis
+import Text.Emoji.Text
+import Text.Emoji.String
+import Text.Emoji.Types
diff --git a/src/Text/Emoji/Emojis.hs b/src/Text/Emoji/Emojis.hs
index de37ac5..cd5428d 100644
--- a/src/Text/Emoji/Emojis.hs
+++ b/src/Text/Emoji/Emojis.hs
@@ -1,4 +1,11 @@
 {-# LANGUAGE TemplateHaskell #-}
+{-|
+    Module:      Text.Emoji.Emojis
+    Description: Exports the representation of all Emojis as list
+
+Exports the parsed emojiData.
+-}
+
 module Text.Emoji.Emojis
   ( emojiData
   ) where
@@ -9,6 +16,10 @@ import Data.Either
 import Data.FileEmbed
 import Text.Parsec
 
+-- | All Emojis listed in emoji-data.txt in a list.
+--   Warning: The data is parsed at run time although emoji-data.txt
+--   is not needed at run time. Hopefully parsing will be done at compile
+--   time in the future.
 emojiData :: [Emoji]
 emojiData = toRights . (\(Right x) -> x) $ parse emojiDataFile "" $(embedStringFile "./emoji-data.txt")
 
diff --git a/src/Text/Emoji/String.hs b/src/Text/Emoji/String.hs
index 6a44828..d10f07b 100644
--- a/src/Text/Emoji/String.hs
+++ b/src/Text/Emoji/String.hs
@@ -10,5 +10,5 @@ import           Text.Emoji.Types
 import           Codec.Binary.UTF8.Light (w2c)
 
 -- | Outputs a String for the given Emoji.
-fromEmoji :: Emoji -> String
-fromEmoji = map w2c . _code
+emojiToString :: Emoji -> String
+emojiToString = map w2c . _code
diff --git a/src/Text/Emoji/Text.hs b/src/Text/Emoji/Text.hs
index d39a26d..4dfdd07 100644
--- a/src/Text/Emoji/Text.hs
+++ b/src/Text/Emoji/Text.hs
@@ -6,7 +6,7 @@
 
 module Text.Emoji.Text where
 
-import qualified Text.Emoji.String as S
+import           Text.Emoji.String
 import           Text.Emoji.Types
 
 import           Data.Text         (Text (), pack)
@@ -14,5 +14,5 @@ import           Data.Text         (Text (), pack)
 -- | Ouputs the given Emoji into Text.
 -- Uses the implementation of Text.Emoji.String
 -- since Text uses Chars, too.
-fromEmoji :: Emoji -> Text
-fromEmoji = pack . S.fromEmoji
+emojiToText :: Emoji -> Text
+emojiToText = pack . emojiToString
diff --git a/src/Text/Emoji/Types.hs b/src/Text/Emoji/Types.hs
index ea9152e..2c76c40 100644
--- a/src/Text/Emoji/Types.hs
+++ b/src/Text/Emoji/Types.hs
@@ -4,7 +4,19 @@
 -}
 
 
-module Text.Emoji.Types where
+module Text.Emoji.Types
+  ( EmojiStyle (..)
+  , EmojiLevel (..)
+  , EmojiModifierStatus (..)
+  , EmojiSource (..)
+  , EmojiSources (..)
+  , Emoji (..)
+  , ParserAssoc (..)
+  , emojiLevels
+  , emojiSources
+  , emojiModifierStati
+  , emojiStyles
+    ) where
 
 import           Data.Char (toLower)
 import           Data.Word (Word32 ())