More comments.

1 files changed, 11 insertions, 2 deletions

diff --git a/Presence/Presence.hs b/Presence/Presence.hs
index c6bf9ffa..4765b05a 100644
--- a/Presence/Presence.hs
+++ b/Presence/Presence.hs
@@ -300,8 +300,10 @@ chooseResourceName state k addr clientsNameForMe desired = do
                         )
                    muid
 
-forClient :: PresenceState
-           -> ConnectionKey -> IO b -> (ClientState -> IO b) -> IO b
+-- Perform action with 'ClientState' associated with the given 'ConnectionKey'.
+-- If there is no associated 'ClientState', then perform the supplied fallback
+-- action.
+forClient :: PresenceState -> ConnectionKey -> IO b -> (ClientState -> IO b) -> IO b
 forClient state k fallback f = do
     mclient <- atomically $ do
         cs <- readTVar (clients state)
@@ -321,6 +323,7 @@ resolveAllPeers :: [Text] -> IO (Map SockAddr ())
 resolveAllPeers hosts = fmap (toMapUnit . concat) $ Prelude.mapM (fmap (take 1) . resolvePeer) hosts
 
 
+-- Read a roster file and start trying to connect to all relevent peers.
 rosterGetStuff
   :: (ConfigFiles.User -> ConfigFiles.Profile -> IO [L.ByteString])
      -> PresenceState -> ConnectionKey -> IO [Text]
@@ -328,11 +331,15 @@ rosterGetStuff what state k = forClient state k (return [])
     $ \client -> do
     jids <- configText what (clientUser client) (clientProfile client)
     let hosts = map ((\(_,h,_)->h) . splitJID) jids
+    -- Using case to bring 'status' type variable to Connection.Manager into scope.
     case state of
       PresenceState { server = svVar } -> do
         (sv,conns) <- atomically $ takeTMVar svVar
         -- Grok peers to associate with from the roster:
         forM_ hosts $ \host -> do
+            -- We need either conns  :: Connection.Manager TCPStatus Text
+            --             or toxman :: ToxManager ConnectionKey
+            -- It is decided by checking hostnames for .tox ending.
             let policySetter = fromMaybe (Connection.setPolicy conns host) $ do
                     toxman <- toxManager state
                     (me  , ".tox") <- Just $ Text.splitAt 43 (clientProfile client)
@@ -348,6 +355,7 @@ rosterGetBuddies state k = rosterGetStuff ConfigFiles.getBuddies state k
 rosterGetSolicited :: PresenceState -> ConnectionKey -> IO [Text]
 rosterGetSolicited = rosterGetStuff ConfigFiles.getSolicited
 
+-- XXX: Should we be connecting to these peers?
 rosterGetOthers :: PresenceState -> ConnectionKey -> IO [Text]
 rosterGetOthers = rosterGetStuff ConfigFiles.getOthers
 
@@ -357,6 +365,7 @@ rosterGetSubscribers = rosterGetStuff ConfigFiles.getSubscribers
 data Conn = Conn { connChan :: TChan Stanza
                  , auxAddr :: SockAddr }
 
+-- Read config file as Text content rather than UTF8 bytestrings.
 configText :: Functor f =>
             (ConfigFiles.User -> ConfigFiles.Profile -> f [L.ByteString])
             -> Text     -- user