Add more code documentation.

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

diff --git a/src/CommandLine.hs b/src/CommandLine.hs
index b734d770b5dde0bcc9c6309254a746aaa60d5eda..adbb0d84c00493bcf2cffbfbbdb1f62cf702e329 100644 (file)
--- a/src/CommandLine.hs
+++ b/src/CommandLine.hs
@@ -36,6 +36,7 @@ my_summary :: String
 my_summary = program_name ++ "-" ++ (showVersion version)
 
 
+-- | A description of the "daemonize" option.
 daemonize_help :: String
 daemonize_help =
   "Run as a daemon, in the background."
@@ -45,6 +46,7 @@ log_file_help :: String
 log_file_help =
   "Log to the given file."
 
+-- | A description of the "log_level" option.
 log_level_help :: String
 log_level_help =
   "How verbose should the logs be? One of INFO, WARNING, ERROR."
@@ -52,21 +54,24 @@ log_level_help =
 -- | A description of the "output_directory" option.
 output_directory_help :: String
 output_directory_help =
-  "Directory in which to output the XML files; must be writable"
+  "Directory in which to output the XML files; must be writable."
 
 -- | A description of the "password" option.
 password_help :: String
 password_help =
-  "Password to use when connecting to the feed"
+  "Password to use when connecting to the feed."
 
+-- | A description of the "pidfile" option.
 pidfile_help :: String
 pidfile_help =
   "Location to create PID file (daemon only)."
 
+-- | A description of the "run_as_group" option.
 run_as_group_help :: String
 run_as_group_help =
   "System group to run as (daemon only)."
 
+-- | A description of the "run_as_user" option.
 run_as_user_help :: String
 run_as_user_help =
   "System user to run under (daemon only)."
@@ -79,7 +84,7 @@ syslog_help =
 -- | A description of the "username" option.
 username_help :: String
 username_help =
-  "Username to use when connecting to the feed"
+  "Username to use when connecting to the feed."
 
 -- | A data structure representing the possible command-line
 --   options. The CmdArgs library is doing heavy magic beneath the