diff --git a/source/Network/Xmpp.hs b/source/Network/Xmpp.hs index 109e1e5..585039e 100644 --- a/source/Network/Xmpp.hs +++ b/source/Network/Xmpp.hs @@ -32,7 +32,7 @@ module Network.Xmpp -- TODO: Close session, etc. -- ** Authentication handlers -- | The use of 'scramSha1' is /recommended/, but 'digestMd5' might be - -- useful for interaction with older implementation + -- useful for interaction with older implementations. , scramSha1 , plain , digestMd5 diff --git a/source/Network/Xmpp/Concurrent.hs b/source/Network/Xmpp/Concurrent.hs index e6a1fda..7242e4c 100644 --- a/source/Network/Xmpp/Concurrent.hs +++ b/source/Network/Xmpp/Concurrent.hs @@ -126,9 +126,8 @@ writeWorker stCh writeR = forever $ do -- | Creates a 'Session' object by setting up a connection with an XMPP server. -- --- Will connect to the specified host. If the fourth parameters is a 'Just' --- value, @session@ will attempt to secure the connection with TLS. If the fifth --- parameters is a 'Just' value, @session@ will attempt to authenticate and +-- Will connect to the specified host with the provided configuration. If the +-- third parameter is a 'Just' value, @session@ will attempt to authenticate and -- acquire an XMPP resource. session :: HostName -- ^ The hostname / realm -> SessionConfiguration -- ^ configuration details diff --git a/source/Network/Xmpp/Utilities.hs b/source/Network/Xmpp/Utilities.hs index 8b4864f..419bd6b 100644 --- a/source/Network/Xmpp/Utilities.hs +++ b/source/Network/Xmpp/Utilities.hs @@ -87,8 +87,9 @@ message = Message { messageID = Nothing , messagePayload = [] } --- Produce an answer message with the given payload, switching the "from" and --- "to" attributes in the original message. +-- | Produce an answer message with the given payload, switching the "from" and +-- "to" attributes in the original message. Produces a 'Nothing' value of the +-- provided message message has no from attribute. answerMessage :: Message -> [Element] -> Maybe Message answerMessage Message{messageFrom = Just frm, ..} payload = Just Message{ messageFrom = messageTo