forge/Vervis
1
0
Fork 0
Code Pull requests Activity

Use --| instead of --^ in AppSettings doc comments

Browse source
This commit is contained in:
fr33domlover 2016-04-19 15:42:54 +00:00
parent 6e29f246bd
commit 242e04a3ce
1 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
src/Vervis/Settings.hs
View file

@ -43,40 +43,40 @@ import Yesod.Default.Util (WidgetFileSettings, widgetFileNoReload,
-- loaded from various sources: defaults, environment variables, config files, -- loaded from various sources: defaults, environment variables, config files,
-- theoretically even a database. -- theoretically even a database.
data AppSettings = AppSettings data AppSettings = AppSettings
{ appStaticDir :: String { -- | Directory from which to serve static files.
-- ^ Directory from which to serve static files. appStaticDir :: String
-- | Configuration settings for accessing the database.
, appDatabaseConf :: PostgresConf , appDatabaseConf :: PostgresConf
-- ^ Configuration settings for accessing the database. -- | Base for all generated URLs. If @Nothing@, determined from the
-- request headers.
, appRoot :: Maybe Text , appRoot :: Maybe Text
-- ^ Base for all generated URLs. If @Nothing@, determined -- | Host/interface the server should bind to.
-- from the request headers.
, appHost :: HostPreference , appHost :: HostPreference
-- ^ Host/interface the server should bind to. -- | Port to listen on
, appPort :: Int , appPort :: Int
-- ^ Port to listen on -- | Get the IP address from the header when logging. Useful when sitting
-- behind a reverse proxy.
, appIpFromHeader :: Bool , appIpFromHeader :: Bool
-- ^ Get the IP address from the header when logging. Useful when sitting
-- behind a reverse proxy.
-- | Use detailed request logging system
, appDetailedRequestLogging :: Bool , appDetailedRequestLogging :: Bool
-- ^ Use detailed request logging system -- | Should all log messages be displayed?
, appShouldLogAll :: Bool , appShouldLogAll :: Bool
-- ^ Should all log messages be displayed? -- | Use the reload version of templates
, appReloadTemplates :: Bool , appReloadTemplates :: Bool
-- ^ Use the reload version of templates -- | Assume that files in the static dir may change after compilation
, appMutableStatic :: Bool , appMutableStatic :: Bool
-- ^ Assume that files in the static dir may change after compilation -- | Perform no stylesheet/script combining
, appSkipCombining :: Bool , appSkipCombining :: Bool
-- ^ Perform no stylesheet/script combining
-- | Path to the directory under which git repos are placed
, appRepoDir :: FilePath , appRepoDir :: FilePath
-- ^ Path to the directory under which git repos are placed -- | Port for the SSH server component to listen on
, appSshPort :: Int , appSshPort :: Int
-- ^ Port for the SSH server component to listen on -- | Path to the server's SSH private key file
, appSshKeyFile :: FilePath , appSshKeyFile :: FilePath
-- ^ Path to the server's SSH private key file -- | Copyright text to appear in the footer of the page
, appCopyright :: Text , appCopyright :: Text
-- ^ Copyright text to appear in the footer of the page
} }
instance FromJSON AppSettings where instance FromJSON AppSettings where