Add Haddock documentation for most functions and types.

[dead/halcyon.git] / src / Twitter / User.hs

diff --git a/src/Twitter/User.hs b/src/Twitter/User.hs
index 217ee7ddeed4e223b415d5d175947f9ff2c39dad..a6fd3f6a459f1d547c10b736a853014964c59101 100644 (file)
--- a/src/Twitter/User.hs
+++ b/src/Twitter/User.hs
@@ -1,3 +1,4 @@
+-- | Functions and data for working with Twitter users.
 module Twitter.User
 where
 
@@ -5,10 +6,13 @@ import Text.XML.HaXml
 
 import Twitter.Xml
 
+-- |Represents a Twitter user, and contains the only attribute thereof
+-- that we care about: the screen (user) name.
 data User = User { screen_name :: String }
           deriving (Show, Eq)
 
 
+-- |Create a 'User' from HaXML 'Content'.
 user_from_content :: Content -> (Maybe User)
 user_from_content c =
     if (length names) == 0