Comment about tox-jabber status equivalents.

1 files changed, 13 insertions, 0 deletions

diff --git a/src/Network/Tox/Crypto/Transport.hs b/src/Network/Tox/Crypto/Transport.hs
index efe491eb..8b7a7222 100644
--- a/src/Network/Tox/Crypto/Transport.hs
+++ b/src/Network/Tox/Crypto/Transport.hs
@@ -86,7 +86,20 @@ data CryptoData = CryptoData
     , bufferData :: CryptoMessage
     }
 
+-- The 'UserStatus' equivalent in Presence is:
+--
+-- data JabberShow = Offline
+--                 | ExtendedAway
+--                 | Away           -- Tox equiv: Away (1)
+--                 | DoNotDisturb   -- Tox equiv: Busy (2)
+--                 | Available      -- Tox equiv: Online (0)
+--                 | Chatty
+--  deriving (Show,Enum,Ord,Eq,Read)
+--
+-- The Enum instance on 'UserStatus' is not arbitrary.  It corresponds
+-- to on-the-wire id numbers.
 data UserStatus = Online | Away | Busy deriving (Show,Eq,Ord,Enum)
+
 data TypingStatus = NotTyping | Typing deriving (Show,Eq,Ord,Enum)
 
 data CryptoMessage