diff --git a/Data/Encoding/ASCII.hs b/Data/Encoding/ASCII.hs index 280f505..4f9cde1 100644 --- a/Data/Encoding/ASCII.hs +++ b/Data/Encoding/ASCII.hs @@ -2,7 +2,7 @@ -- | ASCII (American Standard Code for Information Interchange) is the -- \"normal\" computer encoding using the byte values 0-127 to represent -- characters. Refer to for --- more informations. +-- more information. module Data.Encoding.ASCII (ASCII(..)) where diff --git a/Data/Encoding/CP1250.hs b/Data/Encoding/CP1250.hs index 350e88b..9168e27 100644 --- a/Data/Encoding/CP1250.hs +++ b/Data/Encoding/CP1250.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1250 which encodes languages that use latin script. + See for more information. + -} module Data.Encoding.CP1250 (CP1250(..)) where diff --git a/Data/Encoding/CP1251.hs b/Data/Encoding/CP1251.hs index 877370f..11cab2a 100644 --- a/Data/Encoding/CP1251.hs +++ b/Data/Encoding/CP1251.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1251 which encodes languages that use the cyrillic alphabet. + See for more information. + -} module Data.Encoding.CP1251 (CP1251(..)) where diff --git a/Data/Encoding/CP1252.hs b/Data/Encoding/CP1252.hs index e8e207b..9659917 100644 --- a/Data/Encoding/CP1252.hs +++ b/Data/Encoding/CP1252.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1252 which is a superset of ISO 8859-1. + See for more information. + -} module Data.Encoding.CP1252 (CP1252(..)) where diff --git a/Data/Encoding/CP1253.hs b/Data/Encoding/CP1253.hs index 59b9e07..aa2f4d1 100644 --- a/Data/Encoding/CP1253.hs +++ b/Data/Encoding/CP1253.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1253 which encodes modern greek. + See for more information. + -} module Data.Encoding.CP1253 (CP1253(..)) where diff --git a/Data/Encoding/CP1254.hs b/Data/Encoding/CP1254.hs index 8728cc7..285960c 100644 --- a/Data/Encoding/CP1254.hs +++ b/Data/Encoding/CP1254.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1254 which encodes the turkish language. + See for more information. + -} module Data.Encoding.CP1254 (CP1254(..)) where diff --git a/Data/Encoding/CP1255.hs b/Data/Encoding/CP1255.hs index ef3b2f0..dd1ab02 100644 --- a/Data/Encoding/CP1255.hs +++ b/Data/Encoding/CP1255.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1255 which encodes the hebrew language. + See for more information. + -} module Data.Encoding.CP1255 (CP1255(..)) where diff --git a/Data/Encoding/CP1256.hs b/Data/Encoding/CP1256.hs index 17e1f60..df624d5 100644 --- a/Data/Encoding/CP1256.hs +++ b/Data/Encoding/CP1256.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1256 which encodes languages which use the arabic script. + See for more information. + -} module Data.Encoding.CP1256 (CP1256(..)) where diff --git a/Data/Encoding/CP1257.hs b/Data/Encoding/CP1257.hs index 1240c5f..cf6d7db 100644 --- a/Data/Encoding/CP1257.hs +++ b/Data/Encoding/CP1257.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1257 which encodes the estonian, latvian and lithuanian language. + See for more information. + -} module Data.Encoding.CP1257 (CP1257(..)) where diff --git a/Data/Encoding/CP1258.hs b/Data/Encoding/CP1258.hs index 9d2e0f0..c7325f7 100644 --- a/Data/Encoding/CP1258.hs +++ b/Data/Encoding/CP1258.hs @@ -1,4 +1,7 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} +{- | This module implements Windows Codepage number 1258 which encodes the vietnamese language. + See for more information. + -} module Data.Encoding.CP1258 (CP1258(..)) where diff --git a/Data/Encoding/ISO88591.hs b/Data/Encoding/ISO88591.hs index 836deb3..8c6a60c 100644 --- a/Data/Encoding/ISO88591.hs +++ b/Data/Encoding/ISO88591.hs @@ -1,6 +1,6 @@ {-# LANGUAGE CPP,TemplateHaskell,DeriveDataTypeable #-} {- | Implements ISO\/IEC 8859-1 alias latin-1 encoding. See - for further informations. + for further information. -} module Data.Encoding.ISO88591 (ISO88591(..) diff --git a/Data/Encoding/KOI8R.hs b/Data/Encoding/KOI8R.hs index 7b54124..79c0b67 100644 --- a/Data/Encoding/KOI8R.hs +++ b/Data/Encoding/KOI8R.hs @@ -1,4 +1,7 @@ {-# LANGUAGE DeriveDataTypeable #-} +{- | This module implements KOI8-R encoding which covers the russian and bulgarian alphabet. + See for more information. + -} module Data.Encoding.KOI8R (KOI8R(..)) where diff --git a/Data/Encoding/UTF16.hs b/Data/Encoding/UTF16.hs index 99158ae..38fca04 100644 --- a/Data/Encoding/UTF16.hs +++ b/Data/Encoding/UTF16.hs @@ -1,5 +1,6 @@ {-# LANGUAGE DeriveDataTypeable #-} -{- | This module implements UTF-16 encoding and decoding as in RFC 2781 +{- | This module implements UTF-16 encoding and decoding as in RFC 2781. + See for more information. -} module Data.Encoding.UTF16 (UTF16(..) @@ -18,9 +19,9 @@ import Data.Dynamic (toDyn) import Data.Typeable data UTF16 - = UTF16 - | UTF16BE - | UTF16LE + = UTF16 -- ^ Decodes big and little endian, encodes big endian. + | UTF16BE -- ^ Big endian decoding and encoding, fails if the string isn\'t actually big endian. + | UTF16LE -- ^ Little endian decoding and encoding. deriving (Eq,Show,Typeable) utf16enc :: Bool -> (EncodeState,String) -> Maybe (Word8,(EncodeState,String)) diff --git a/Data/Encoding/UTF32.hs b/Data/Encoding/UTF32.hs index 6be5950..2611b7e 100644 --- a/Data/Encoding/UTF32.hs +++ b/Data/Encoding/UTF32.hs @@ -1,4 +1,7 @@ {-# LANGUAGE DeriveDataTypeable #-} +{- | This module implements UTF-32 encoding and decoding. + See for more information. + -} module Data.Encoding.UTF32 (UTF32(..)) where diff --git a/Data/Encoding/UTF8.hs b/Data/Encoding/UTF8.hs index fa39813..118596e 100644 --- a/Data/Encoding/UTF8.hs +++ b/Data/Encoding/UTF8.hs @@ -1,5 +1,6 @@ {-# LANGUAGE DeriveDataTypeable #-} {- | This module implements UTF-8 encoding and decoding as in RFC 3629. + See for more information. -} module Data.Encoding.UTF8 (UTF8(..)) where @@ -14,8 +15,8 @@ import Control.Exception import Data.Typeable data UTF8 - = UTF8 - | UTF8Strict + = UTF8 -- ^ Very forgiving decoding mechanism, accepts everything that it can make any sense of. + | UTF8Strict -- ^ More strict decoding, doesn\'t accept sequences that have a too long representation and checks bits that aren\'t used in the decoding. deriving (Eq,Show,Typeable) encodeUTF8 :: Char -> (Word8,EncodeState)