From c0f97175d4db2f060f1a96b54f650704258615cc Mon Sep 17 00:00:00 2001 From: Philipp Balzarek Date: Sun, 24 Mar 2013 17:46:12 +0100 Subject: [PATCH] fix haddock documentation --- source/Network/Xmpp/Concurrent/IQ.hs | 9 +++++++-- source/Network/Xmpp/Stream.hs | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/source/Network/Xmpp/Concurrent/IQ.hs b/source/Network/Xmpp/Concurrent/IQ.hs index 54f4a17..a3c1860 100644 --- a/source/Network/Xmpp/Concurrent/IQ.hs +++ b/source/Network/Xmpp/Concurrent/IQ.hs @@ -62,9 +62,14 @@ sendIQ' to tp lang body session = do -- | Retrieves an IQ listener channel. If the namespace/'IQRequestType' is not -- already handled, a new 'TChan' is created and returned as a 'Right' value. -- Otherwise, the already existing channel will be returned wrapped in a 'Left' --- value. Note that the 'Left' channel might need to be duplicated in order not +-- value. The 'Left' channel might need to be duplicated in order not -- to interfere with existing consumers. -listenIQChan :: IQRequestType -- ^ Type of IQs to receive (@Get@ or @Set@) +-- +-- Note thet every 'IQRequest' must be answered exactly once. To insure this, +-- the incoming requests are wrapped in an 'IQRequestTicket' that prevents +-- multiple responses. Use 'iqRequestBody' to extract the corresponding request +-- and 'answerIQ' to send the response +listenIQChan :: IQRequestType -- ^ Type of IQs to receive ('Get' or 'Set') -> Text -- ^ Namespace of the child element -> Session -> IO (Either (TChan IQRequestTicket) (TChan IQRequestTicket)) diff --git a/source/Network/Xmpp/Stream.hs b/source/Network/Xmpp/Stream.hs index 2310131..110f0c2 100644 --- a/source/Network/Xmpp/Stream.hs +++ b/source/Network/Xmpp/Stream.hs @@ -151,7 +151,7 @@ startStream = runErrorT $ do -- HACK: We ignore MUST-strength requirement (section 4.7.4. of RFC -- 6120) for the sake of compatibility with jabber.org - -- | lt == Nothing -> + -- | lt == Nothing -> -- closeStreamWithError StreamInvalidXml Nothing -- "Stream has no language tag"