Documentation

[Lucu.git] / Network / HTTP / Lucu / ETag.hs

diff --git a/Network/HTTP/Lucu/ETag.hs b/Network/HTTP/Lucu/ETag.hs
index 86dd429e265100b8318716679ebfd4d0554120b0..856588364b7c1a73daa4c2d46c280feefa18bbf0 100644 (file)
--- a/Network/HTTP/Lucu/ETag.hs
+++ b/Network/HTTP/Lucu/ETag.hs
@@ -1,10 +1,12 @@
+-- #prune
+
+-- |Creation and comparison of entity tags.
 module Network.HTTP.Lucu.ETag
-    ( ETag
-    , mkETag     -- Bool -> String -> ETag
-    , strongETag -- String -> ETag
-    , weakETag   -- String -> ETag
-    , eTagP     -- Parser ETag
-    , eTagListP -- Parser [ETag]
+    ( ETag(..)
+    , strongETag
+    , weakETag
+    , eTagP
+    , eTagListP
     )
     where
 
@@ -13,9 +15,13 @@ import           Network.HTTP.Lucu.Parser
 import           Network.HTTP.Lucu.Parser.Http
 import           Network.HTTP.Lucu.Utils
 
-
+-- |An entity tag is made of a weakness flag and a opaque string.
 data ETag = ETag {
+      -- |The weakness flag. Weak tags looks like W\/\"blahblah\" and
+      -- strong tags are like \"blahblah\".
       etagIsWeak :: Bool
+      -- |An opaque string. Only characters from 0x20 (sp) to 0x7e (~)
+      -- are allowed.
     , etagToken  :: String
     } deriving (Eq)
 
@@ -27,15 +33,13 @@ instance Show ETag where
                                ++
                                quoteStr token
 
-
-mkETag :: Bool -> String -> ETag
-mkETag = ETag
-
-
+-- |This is an equivalent to @'ETag' False@. If you want to generate
+-- an ETag from a file, try using
+-- 'Network.HTTP.Lucu.StaticFile.generateETagFromFile'.
 strongETag :: String -> ETag
 strongETag = ETag False
 
-
+-- |This is an equivalent to @'ETag' True@.
 weakETag :: String -> ETag
 weakETag = ETag True
 
@@ -43,7 +47,7 @@ weakETag = ETag True
 eTagP :: Parser ETag
 eTagP = do isWeak <- option False (string "W/" >> return True)
            str    <- quotedStr
-           return $ mkETag isWeak str
+           return $ ETag isWeak str
 
 
 eTagListP :: Parser [ETag]