From 66bed533fe8727300057dc1ba643e08c0a483247 Mon Sep 17 00:00:00 2001 From: Victor Denisov Date: Mon, 20 Jun 2016 18:49:31 -0700 Subject: [PATCH] Add documentation for Transport module --- Database/MongoDB/Transport.hs | 14 +++++++++++--- Database/MongoDB/Transport/Tls.hs | 1 - 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/Database/MongoDB/Transport.hs b/Database/MongoDB/Transport.hs index dffdd35..a7d5d98 100644 --- a/Database/MongoDB/Transport.hs +++ b/Database/MongoDB/Transport.hs @@ -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 --- network connection, TLS connection, a mock or anything else. +This module defines a connection interface. It could be a regular +network connection, TLS connection, a mock or anything else. +-} module Database.MongoDB.Transport ( Transport(..), @@ -22,7 +30,7 @@ data Transport = Transport { close :: IO ()} fromHandle :: Handle -> IO Transport --- ^ Make connection form handle +-- ^ Make connection from handle fromHandle handle = do return Transport { read = ByteString.hGet handle diff --git a/Database/MongoDB/Transport/Tls.hs b/Database/MongoDB/Transport/Tls.hs index fa1fc0f..69aad19 100644 --- a/Database/MongoDB/Transport/Tls.hs +++ b/Database/MongoDB/Transport/Tls.hs @@ -10,7 +10,6 @@ {-| Module : MongoDB TLS -Description : TLS transport for mongodb Copyright : (c) Yuras Shumovich, 2016 License : Apache 2.0 Maintainer : Victor Denisov denisovenator@gmail.com