From: PHO <pho@cielonegro.org>
Date: Thu, 18 Mar 2010 04:08:53 +0000 (+0900)
Subject: haddock comments
X-Git-Tag: RELEASE-0.1.0.1~5
X-Git-Url: https://git.cielonegro.org/gitweb.cgi?a=commitdiff_plain;h=c6072393ea3d4d19639f410d2010b4815baad9e7;p=time-http.git

haddock comments
---

diff --git a/Data/Time/Asctime.hs b/Data/Time/Asctime.hs
index 7ebb596..0da5305 100644
--- a/Data/Time/Asctime.hs
+++ b/Data/Time/Asctime.hs
@@ -1,3 +1,23 @@
+-- |This module is for ANSI C's asctime() format.
+--
+-- ANSI C's asctime() format looks like:
+--
+-- @Wdy Mon DD HH:MM:SS YYYY@
+--
+-- The exact syntax is as follows:
+--
+-- > date-time ::= wday ' ' month ' ' day ' ' time ' ' year
+-- > wday      ::= "Mon" | "Tue" | "Wed" | "Thu"
+-- >             | "Fri" | "Sat" | "Sun"
+-- > month     ::= "Jan" | "Feb" | "Mar" | "Apr"
+-- >             | "May" | "Jun" | "Jul" | "Aug"
+-- >             | "Sep" | "Oct" | "Nov" | "Dec"
+-- > day       ::= 2DIGIT
+-- > time      ::= 2DIGIT ':' 2DIGIT [':' 2DIGIT]
+-- > year      ::= 4DIGIT
+--
+-- As you can see, it has no time zone info. "Data.Time.HTTP" will
+-- treat it as UTC.
 module Data.Time.Asctime
     ( format
     , parse
@@ -11,10 +31,7 @@ import Data.Time.Calendar.WeekDate
 import Data.Time.HTTP.Common
 import Data.Time.Asctime.Parsec
 
-{-
-  Wdy Mon DD HH:MM:SS YYYY
--}
-
+-- |Format a 'LocalTime' in the ANSI C's asctime() way.
 format :: LocalTime -> String
 format localTime
     = let (year, month, day) = toGregorian (localDay localTime)
@@ -36,6 +53,8 @@ format localTime
                , show4 year
                ]
 
+-- |Parse an ANSI C's asctime() format to 'LocalTime'. When the string
+-- can't be parsed, it returns 'Nothing'.
 parse :: String -> Maybe LocalTime
 parse src = case P.parse p "" src of
               Right zt -> Just zt
diff --git a/Data/Time/Asctime/Parsec.hs b/Data/Time/Asctime/Parsec.hs
index 3cff94c..201f347 100644
--- a/Data/Time/Asctime/Parsec.hs
+++ b/Data/Time/Asctime/Parsec.hs
@@ -11,7 +11,7 @@ import Data.Time.Calendar.WeekDate
 import Data.Time.HTTP.Common
 import Text.Parsec
 
-
+-- |This is a parsec parser for ANSI C's asctime() format.
 asctime :: Stream s m Char => ParsecT s u m LocalTime
 asctime = do weekDay <- shortWeekDayNameP
              _       <- string ", "