Clean up a bunch of code and comments.

[dead/halcyon.git] / src / CommandLine.hs

diff --git a/src/CommandLine.hs b/src/CommandLine.hs
index 65054fe959902fab46f98c5b9112a7ac195d5c62..01b5a806219e8f131fc69b9a7646f64890e3b02e 100644 (file)
--- a/src/CommandLine.hs
+++ b/src/CommandLine.hs
@@ -16,57 +16,100 @@ import System.Console.CmdArgs (
   summary,
   typ,
   versionArg )
-import System.Environment (withArgs)
+import System.Environment ( withArgs )
 
 -- Get the version from Cabal.
-import Paths_halcyon (version)
-import Data.Version (showVersion)
+import Paths_halcyon ( version )
+import Data.Version ( showVersion )
 
 import OptionalConfiguration ( OptionalCfg(..) )
 
+
+-- | The description of the program, displayed as part of the help.
+--
 description :: String
 description =
   "Monitor a list of Twitter accounts and display or email any new tweets."
 
+
+-- | The name of this program.
+--
 program_name :: String
 program_name = "halcyon"
 
+
+-- | A summary string output as part of the help.
+--
 my_summary :: String
 my_summary = program_name ++ "-" ++ (showVersion version)
 
+
+-- | Help string for the \"consumer_key\" option.
+--
 consumer_key_help :: String
 consumer_key_help = "Your Twitter API consumer key"
 
+
+-- | Help string for the \"consumer_secret\" option.
+--
 consumer_secret_help :: String
 consumer_secret_help = "Your Twitter API consumer secret"
 
+
+-- | Help string for the \"access_token\" option
+--
 access_token_help :: String
 access_token_help = "Your Twitter API access token"
 
+
+-- | Help string for the \"access_secret\" option.
+--
 access_secret_help :: String
 access_secret_help = "Your Twitter API access secret"
 
+
+-- | Help string for the \"heartbeat\" option.
+--
 heartbeat_help :: String
 heartbeat_help = "How many seconds to wait between polling"
 
+
+-- | Help string for the \"to_address\" option.
+--
 to_address_help :: String
 to_address_help = "Send tweets to ADDRESS"
 
+
+-- | Help string for the \"from_address\" option.
+--
 from_address_help :: String
 from_address_help = "Send tweets from ADDRESS"
 
+
+-- | Help string for the \"sendmail_path\" option.
+--
 sendmail_path_help :: String
 sendmail_path_help = "Use PATH to send mail"
 
+
+-- | Help string for the \"ignore_replies\" option.
+--
 ignore_replies_help :: String
 ignore_replies_help = "Ignore replies to other tweets"
 
+
+-- | Help string for the \"ignore_retweets\" option.
+--
 ignore_retweets_help :: String
 ignore_retweets_help = "Ignore retweets from other users"
 
+
+-- | Help string for the \"verbose\" option.
+--
 verbose_help :: String
 verbose_help = "Be verbose about stuff"
 
+
 arg_spec :: OptionalCfg
 arg_spec =
   OptionalCfg {