Add a little more documentation.

[dead/htsn-common.git] / src / Network / Services / TSN / Terminal.hs

diff --git a/src/Network/Services/TSN/Terminal.hs b/src/Network/Services/TSN/Terminal.hs
index e24d23cb48ccbb3bd5c15c47cd11aa5f42af3aad..c36e90c89461469e1b04745d75a8c612e1e54ad2 100644 (file)
--- a/src/Network/Services/TSN/Terminal.hs
+++ b/src/Network/Services/TSN/Terminal.hs
@@ -1,3 +1,7 @@
+-- | Terminal output functions for displaying informational
+--   messages. The output is color-coded according to severity, and is
+--   designed at the moment for consoles with a dark background.
+--
 module Network.Services.TSN.Terminal (
   display_debug,
   display_error,
@@ -55,25 +59,28 @@ display_sent = hPutStrColor stdout Green
 
 
 -- | Display debug text on the console. Don't automatically append a
---   newline in case the raw text is needed for, uh, debugging.
+--   newline in case the raw text is needed for, uh, debugging. The
+--   text color is not altered.
 --
 display_debug :: String -> IO ()
 display_debug = putStr
 
 
--- | Display an informational message on the console.
+-- | Display an informational message on the console in cyan.
 --
 display_info :: String -> IO ()
 display_info = hPutStrColorLn stdout Cyan
 
 
--- | Display a warning on the console. Uses stderr instead of stdout.
+-- | Display a warning on the console in yello. Uses stderr instead of
+--   stdout.
 --
 display_warning :: String -> IO ()
 display_warning = hPutStrColorLn stderr Yellow
 
 
--- | Display an error on the console. Uses stderr instead of stdout.
+-- | Display an error on the console in red. Uses stderr instead of
+--   stdout.
 --
 display_error :: String -> IO ()
 display_error = hPutStrColorLn stderr Red