mark additional @since
authorAshley Yakeley <ashley@semantic.org>
Tue, 31 Jul 2018 21:51:41 +0000 (14:51 -0700)
committerAshley Yakeley <ashley@semantic.org>
Tue, 31 Jul 2018 21:51:41 +0000 (14:51 -0700)
changelog.md
lib/Data/Time/Calendar/CalendarDiffDays.hs
lib/Data/Time/Format/Format/Class.hs
lib/Data/Time/Format/Parse/Class.hs
lib/Data/Time/LocalTime/Internal/CalendarDiffTime.hs

index c303939..ce80e9f 100644 (file)
@@ -2,6 +2,7 @@
 
 ## [1.9.2]
 - add Data and Typeable instance for CalendarDiffDays and CalendarDiffTime
+- "@since" annotations for everything after 1.9
 
 ## [1.9.1]
 - new functions secondsToNominalDiffTime & nominalDiffTimeToSeconds
index 73c779d..5e0960c 100644 (file)
@@ -17,7 +17,10 @@ import Data.Data
 data CalendarDiffDays = CalendarDiffDays
     { cdMonths :: Integer
     , cdDays :: Integer
-    } deriving (Eq,Data,Typeable)
+    } deriving (Eq,
+    Data -- ^ @since 1.9.2
+    ,Typeable -- ^ @since 1.9.2
+    )
 
 #if MIN_VERSION_base(4,9,0)
 -- | Additive
index 54d2ac8..96567e9 100644 (file)
@@ -28,6 +28,7 @@ data FormatOptions = MkFormatOptions {
 
 -- <http://www.opengroup.org/onlinepubs/007908799/xsh/strftime.html>
 class FormatTime t where
+    -- | @since 1.9.1
     formatCharacter :: Bool -> Char -> Maybe (FormatOptions -> t -> String)
 
 
index 27e56af..cfab53e 100644 (file)
@@ -21,15 +21,20 @@ data ParseNumericPadding = NoPadding | SpacePadding | ZeroPadding
 -- | The class of types which can be parsed given a UNIX-style time format
 -- string.
 class ParseTime t where
+    -- | @since 1.9.1
     substituteTimeSpecifier :: proxy t -> TimeLocale -> Char -> Maybe String
     substituteTimeSpecifier _ _ _ = Nothing
     -- | Get the string corresponding to the given format specifier.
+    --
+    -- @since 1.9.1
     parseTimeSpecifier :: proxy t -> TimeLocale -> Maybe ParseNumericPadding -> Char -> ReadP String
     -- | Builds a time value from a parsed input string.
     -- If the input does not include all the information needed to
     -- construct a complete value, any missing parts should be taken
     -- from 1970-01-01 00:00:00 +0000 (which was a Thursday).
     -- In the absence of @%C@ or @%Y@, century is 1969 - 2068.
+    --
+    -- @since 1.9.1
     buildTime :: TimeLocale -- ^ The time locale.
               -> [(Char,String)] -- ^ Pairs of format characters and the
                                  -- corresponding part of the input.
index 0629b7e..a101d2d 100644 (file)
@@ -19,7 +19,10 @@ import Data.Time.Clock.Internal.NominalDiffTime
 data CalendarDiffTime = CalendarDiffTime
     { ctMonths :: Integer
     , ctTime :: NominalDiffTime
-    } deriving (Eq,Data,Typeable)
+    } deriving (Eq,
+    Data -- ^ @since 1.9.2
+    ,Typeable -- ^ @since 1.9.2
+    )
 #if MIN_VERSION_base(4,9,0)
 -- | Additive
 instance Semigroup CalendarDiffTime where