fix(doc): fix erroneous unintentional haddock annotations

This commit is contained in:
Steffen Jost 2024-06-27 16:48:47 +02:00
parent e25a8569c5
commit 3dfc7f8c8b
4 changed files with 56 additions and 56 deletions

View File

@ -58,7 +58,7 @@ data CU_AvsPersonInfo_User
| CU_API_UserMatrikelnummer
| CU_API_UserCompanyPersonalNumber
| CU_API_UserLdapPrimaryKey
-- | CU_API_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
-- CU_API_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
deriving (Show, Eq)
instance MkCheckUpdate CU_AvsPersonInfo_User where
@ -87,7 +87,7 @@ instance MkCheckUpdate CU_AvsDataContcat_User where
data CU_AvsFirmInfo_User
= CU_AFI_UserPostAddress
-- | CU_AFI_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
-- CU_AFI_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
deriving (Show, Eq)
instance MkCheckUpdate CU_AvsFirmInfo_User where
@ -100,7 +100,7 @@ instance MkCheckUpdate CU_AvsFirmInfo_User where
-- NOTE: Ensure that the lenses between CU_UserAvs_User and CU_AvsPersonInfo_User/CU_AvsFirmInfo_User agree!
data CU_UserAvs_User
= CU_UA_UserPinPassword
-- | CU_UA_UserPostAddress -- use _avsContactPrimaryPostAddress instead
-- CU_UA_UserPostAddress -- use _avsContactPrimaryPostAddress instead
| CU_UA_UserFirstName
| CU_UA_UserSurname
| CU_UA_UserDisplayName
@ -109,7 +109,7 @@ data CU_UserAvs_User
| CU_UA_UserMatrikelnummer
| CU_UA_UserCompanyPersonalNumber
| CU_UA_UserLdapPrimaryKey
-- | CU_UA_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
-- CU_UA_UserDisplayEmail -- use _avsContactPrimaryEmailAddress instead
deriving (Show, Eq)
instance MkCheckUpdate CU_UserAvs_User where

View File

@ -102,10 +102,10 @@ data Job
, jIteration :: Natural
, jSynchAfter :: Maybe Day
}
-- | JobSynchroniseAvsUser { jUser :: UserId
-- JobSynchroniseAvsUser { jUser :: UserId
-- , jSynchAfter :: Maybe Day
-- }
-- | JobSynchroniseAvsId { jAvsId :: AvsPersonId
-- JobSynchroniseAvsId { jAvsId :: AvsPersonId
-- , jSynchAfter :: Maybe Day
-- }
| JobSynchroniseAvsQueue

View File

@ -181,7 +181,7 @@ splitQuery rawQuery q
-- cardMatch AvsDataPersonCard{..} =
-- avsDataValid && (avsDataValidTo >= cutoff) && (licence `Set.member` avsDataCardAreas)
-- | DEPRECTATED
-- -- DEPRECTATED
-- getCompanyAddress :: AvsDataPersonCard -> (Maybe Text, Maybe Text, Maybe AvsDataPersonCard)
-- getCompanyAddress card@AvsDataPersonCard{..}
-- | Just street <- avsDataStreet
@ -191,7 +191,7 @@ splitQuery rawQuery q
-- | isJust avsDataFirm = (avsDataFirm, Nothing, Just card)
-- | otherwise = (Nothing, Nothing, Nothing)
-- -- | From a set of card, choose the one with the most complete postal address.
-- -- From a set of card, choose the one with the most complete postal address.
-- -- Returns company, postal address and the associated card where the address was taken from
-- guessLicenceAddress :: Set AvsDataPersonCard -> (Maybe Text, Maybe Text, Maybe AvsDataPersonCard)
-- guessLicenceAddress cards

View File

@ -40,7 +40,7 @@ data Icon
| IconProblem
| IconVisible
| IconInvisible
-- | IconCourse -- not used, IconMenuCourse is currently only used
-- IconCourse -- not used, IconMenuCourse is currently only used
| IconCourseFavouriteManual | IconCourseFavouriteAutomatic | IconCourseFavouriteOff
| IconEnrolTrue
| IconEnrolFalse
@ -110,7 +110,7 @@ data Icon
| IconAt
| IconSupervisor
| IconSupervisorForeign
-- | IconWaitingForUser
-- IconWaitingForUser
| IconExpired
| IconLocked
| IconUnlocked
@ -118,7 +118,7 @@ data Icon
| IconCompany
| IconEdit
| IconUserEdit
-- | IconMagic -- indicates automatic updates
-- IconMagic -- indicates automatic updates
deriving (Eq, Ord, Enum, Bounded, Show, Read, Generic)
deriving anyclass (Universe, Finite, NFData)