Some haddock

This commit is contained in:
Gregor Kleen 2019-05-27 14:45:08 +02:00
parent dbb208112f
commit 06862cf8fd
10 changed files with 52 additions and 0 deletions

View File

@ -1,3 +1,9 @@
{-|
Module: Model.Types.Common
Description: Common types used by most @Model.Types.*@-Modules
Types used by multiple other @Model.Types.*@-Modules
-}
module Model.Types.Common
( module Model.Types.Common
) where

View File

@ -1,3 +1,9 @@
{-|
Module: Model.Types.Course
Description: Types for modeling Courses
Also see `Model.Types.Sheet`
-}
module Model.Types.Course
( module Model.Types.Course
) where

View File

@ -1,3 +1,9 @@
{-|
Module: Model.Types.DateTime
Description: Time related types
Terms, Seasons, and Occurence schedules
-}
module Model.Types.DateTime
( module Model.Types.DateTime
) where
@ -58,6 +64,7 @@ instance Enum TermIdentifier where
-- from_TermIdentifier_to_TermId = TermKey
shortened :: Iso' Integer Integer
-- ^ Year numbers shortened to two digits
shortened = iso shorten expand
where
century = ($currentYear `div` 100) * 100

View File

@ -1,3 +1,7 @@
{-|
Module: Model.Types.Exam
Description: Types for modeling Exams
-}
module Model.Types.Exam
( module Model.Types.Exam
) where

View File

@ -1,3 +1,7 @@
{-|
Module: Model.Types.Health
Description: Types for running self-tests
-}
module Model.Types.Health
( module Model.Types.Health
) where

View File

@ -1,6 +1,11 @@
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE UndecidableInstances #-}
{-|
Module: Model.Types.Mail
Description: Types related to Notifications
-}
module Model.Types.Mail
( module Model.Types.Mail
) where

View File

@ -1,3 +1,8 @@
{-|
Module: Model.Types.Misc
Description: Additional uncategorized types
-}
module Model.Types.Misc
( module Model.Types.Misc
) where

View File

@ -1,5 +1,10 @@
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-|
Module: Model.Types.Security
Description: Types for authentication and authorisation
-}
module Model.Types.Security
( module Model.Types.Security
) where

View File

@ -1,3 +1,8 @@
{-|
Module: Model.Types.Sheet
Description: Types for modeling sheets
-}
module Model.Types.Sheet
( module Model.Types.Sheet
) where

View File

@ -1,5 +1,10 @@
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-|
Module: Model.Types.Submission
Description: Types to support sheet submissions
-}
module Model.Types.Submission
( module Model.Types.Submission
) where