Merge pull request #62 from qrilka/haddock-fixes

Haddock fixes
informatikr · Mar 24, 2016 · 74cc620 · 74cc620
2 parents 15da23e + 11ae21f
commit 74cc620
Show file tree

Hide file tree

Showing 2 changed files with 159 additions and 152 deletions.
diff --git a/codegen/GenCmds.hs b/codegen/GenCmds.hs
@@ -101,6 +101,7 @@ data Cmd = Cmd { cmdName, cmdGroup :: String
                , cmdRetType        :: Maybe String
                , cmdArgs           :: [Arg]
                , cmdSummary        :: String
+               , cmdSince          :: String
                }
     deriving (Show)
 
@@ -123,6 +124,7 @@ instance FromJSON Cmds where
             cmdGroup   <- cmd .: "group"
             cmdRetType <- cmd .:? "returns"
             cmdSummary <- cmd .: "summary"
+            cmdSince   <- cmd .: "since"
             cmdArgs    <- cmd .:? "arguments" .!= []
                             <|> error ("failed to parse args: " ++ cmdName)
             return Cmd{..})
@@ -253,8 +255,12 @@ exportCmdNames Cmd{..} = types `mappend` functions
         Just (Just (_,ts)) -> ts
         Just Nothing       -> error "unhandled"
 
+    dropTrailingDot s = case reverse s of
+        ('.':rest) -> reverse rest
+        _          -> s
+
     haddock = mconcat
-        [ fromString "-- |", fromString cmdSummary
+        [ fromString "-- |", fromString (dropTrailingDot cmdSummary)
         , fromString " ("
         , cmdDescriptionLink cmdName
         , fromString ")."
@@ -267,6 +273,7 @@ exportCmdNames Cmd{..} = types `mappend` functions
                 , fromString "'."
                 ]
             else mempty
+        , fromString " Since Redis ", fromString cmdSince
         ]
 
 cmdDescriptionLink :: String -> Builder