rollbar-wai - Adding missing documentation

rollbar-wai/example/Main.hs

@@ -10,8 +10,9 @@ import Rollbar.Wai
 main :: IO ()
 main = do
   settings <- readSettings "rollbar.yaml"
-  let warpSettings = setOnException (rollbarOnException settings) defaultSettings
-  runSettings warpSettings app
+  runSettings
+    (setOnException (rollbarOnException settings) defaultSettings)
+    app
 
 app :: Application
 app _ _ = error "Boom"

rollbar-wai/src/Rollbar/Wai.hs

@@ -5,6 +5,10 @@
 -- Copyright: (c) 2020 Stack Builders Inc.
 -- License: MIT
 -- Maintainer: Sebastián Estrella <[email protected]>
+--
+-- For a fully working example check the following link:
+--
+-- <https://github.com/stackbuilders/rollbar-haskell/blob/master/rollbar-wai/example/Main.hs>
 module Rollbar.Wai
   ( rollbarOnException
   , rollbarOnExceptionWith
@@ -26,13 +30,29 @@ import Data.Aeson
 import Network.HTTP.Types (renderQuery)
 import Rollbar.Client
 
+-- | Sends the captured 'SomeException' to Rollbar API using the given
+-- 'Settings'. Under the hood, this function uses 'createItem' function from
+-- rollbar-client.
+--
+-- __Example__
+--
+-- > settings <- readSettings "rollbar.yaml"
+-- > runSettings
+-- >   (setOnException (rollbarOnException settings) defaultSettings)
+-- >   app
+--
+-- @since 0.1.0
 rollbarOnException
   :: Settings
   -> Maybe W.Request
   -> SomeException
   -> IO ()
 rollbarOnException = rollbarOnExceptionWith (void . createItem)
 
+-- | Similar to 'rollbarOnExceptionWith', but it allows customize the function
+-- used to send the 'Item' to Rollbar.
+--
+-- @since 0.1.0
 rollbarOnExceptionWith
   :: (Item -> Rollbar ())
   -> Settings
@@ -45,6 +65,9 @@ rollbarOnExceptionWith f settings waiRequest ex =
     request <- mapM mkRequest waiRequest
     f item { itemRequest = request }
 
+-- | Transforms a Wai 'W.Request' into a Rollbar 'Request'.
+--
+-- @since 0.1.0
 mkRequest :: MonadIO m => W.Request -> m Request
 mkRequest req = liftIO $ do
   (params, _) <- W.parseRequestBody ignoreFiles req

rollbar-yesod/src/Rollbar/Yesod.hs

@@ -40,7 +40,7 @@ rollbarYesodMiddleware = rollbarYesodMiddlewareWith $ \settings request ex ->
   liftIO $ rollbarOnException settings (Just request) ex
 
 -- | Similar to 'rollbarYesodMiddleware', but it allows customize the function
--- used to send the 'SomeException' capture from a handler to Rollbar.
+-- used to send the 'SomeException' captured from a handler to Rollbar.
 rollbarYesodMiddlewareWith
   :: (HasSettings m, MonadHandler m, MonadUnliftIO m)
   => (Settings -> W.Request -> SomeException -> m ())