Documentation.

portnov [2009-07-07 19:20:28]
Documentation.
Filename
Framework/Config.hs
Framework/Types.hs
diff --git a/Framework/Config.hs b/Framework/Config.hs
index 2fff319..ef29c8b 100644
--- a/Framework/Config.hs
+++ b/Framework/Config.hs
@@ -22,7 +22,10 @@ getConfigPath name = do
 get' :: CF.Get_C a => CF.ConfigParser -> CF.SectionSpec -> CF.OptionSpec -> a -> a
 get' cp s o d = either (const d) id $ CF.get cp s o

-readConfig :: String -> StartupConfig -> IO StaticConfig
+-- | Read config from file
+readConfig :: String          -- ^ Config name
+           -> StartupConfig   -- ^ Parameters that are no in the config
+           -> IO StaticConfig
 readConfig name sc = do
     path <- getConfigPath name
     ecp <- CF.readfile CF.emptyCP path
diff --git a/Framework/Types.hs b/Framework/Types.hs
index 4c2a730..687f6c5 100644
--- a/Framework/Types.hs
+++ b/Framework/Types.hs
@@ -30,6 +30,7 @@ type HttpResponse = Response String

 -------------------------------------------------------------------------------------------

+-- | This object contains config which is common for all requests
 data StaticConfig = HP {
     portNumber :: Int,             -- ^ Port number to listen
     docdir :: String,              -- ^ Static content directory
@@ -48,6 +49,7 @@ data StaticConfig = HP {
     }
     deriving (Show)

+-- | Temporarly object, contains part of StaticConfig which is not read from file
 data StartupConfig = StartupConfig {
     dbpoolSC :: MPool DBConnection,  -- ^ DB connections pool
     cpoolSC :: MPool CacheConnection,-- ^ Cache connections pool
ViewGit