Add documentation for Transport module

This commit is contained in:
Victor Denisov 2016-06-20 18:49:31 -07:00
parent e59e1d6ba6
commit 66bed533fe
No known key found for this signature in database
GPG key ID: 89596023D19E4238
2 changed files with 11 additions and 4 deletions

View file

@ -1,6 +1,14 @@
{-|
Module : MongoDB TLS
Copyright : (c) Victor Denisov, 2016
License : Apache 2.0
Maintainer : Victor Denisov denisovenator@gmail.com
Stability : alpha
Portability : POSIX
-- | This module defines a connection interface. It could be a regular This module defines a connection interface. It could be a regular
-- network connection, TLS connection, a mock or anything else. network connection, TLS connection, a mock or anything else.
-}
module Database.MongoDB.Transport ( module Database.MongoDB.Transport (
Transport(..), Transport(..),
@ -22,7 +30,7 @@ data Transport = Transport {
close :: IO ()} close :: IO ()}
fromHandle :: Handle -> IO Transport fromHandle :: Handle -> IO Transport
-- ^ Make connection form handle -- ^ Make connection from handle
fromHandle handle = do fromHandle handle = do
return Transport return Transport
{ read = ByteString.hGet handle { read = ByteString.hGet handle

View file

@ -10,7 +10,6 @@
{-| {-|
Module : MongoDB TLS Module : MongoDB TLS
Description : TLS transport for mongodb
Copyright : (c) Yuras Shumovich, 2016 Copyright : (c) Yuras Shumovich, 2016
License : Apache 2.0 License : Apache 2.0
Maintainer : Victor Denisov denisovenator@gmail.com Maintainer : Victor Denisov denisovenator@gmail.com