More Haddock fixes

This commit is contained in:
Sibi Prabakaran 2016-12-06 18:44:38 +05:30
parent 75df4e0468
commit 47b2877c79
No known key found for this signature in database
GPG Key ID: D19E3E0EBB557613

View File

@ -17,14 +17,17 @@
-- --
-- This is a standard registration e-mail flow -- This is a standard registration e-mail flow
-- --
-- 1) A user registers a new e-mail address, and an e-mail is sent there -- 1. A user registers a new e-mail address, and an e-mail is sent there
-- 2) The user clicks on the registration link in the e-mail -- 2. The user clicks on the registration link in the e-mail. Note that
-- Note that at this point they are actually logged in (without a password) -- at this point they are actually logged in (without a
-- That means that when they log out they will need to reset their password -- password). That means that when they log out they will need to
-- 3) The user sets their password and is redirected to the site. -- reset their password.
-- 4) The user can now -- 3. The user sets their password and is redirected to the site.
-- * logout and sign in -- 4. The user can now
-- * reset their password --
-- * logout and sign in
-- * reset their password
--
module Yesod.Auth.Email module Yesod.Auth.Email
( -- * Plugin ( -- * Plugin
authEmail authEmail
@ -240,7 +243,7 @@ class ( YesodAuth site
-- --
-- Default: 'defaultRegisterHandler'. -- Default: 'defaultRegisterHandler'.
-- --
-- @since: 1.2.6. -- @since: 1.2.6
registerHandler :: AuthHandler site Html registerHandler :: AuthHandler site Html
registerHandler = defaultRegisterHandler registerHandler = defaultRegisterHandler
@ -250,7 +253,7 @@ class ( YesodAuth site
-- --
-- Default: 'defaultForgotPasswordHandler'. -- Default: 'defaultForgotPasswordHandler'.
-- --
-- @since: 1.2.6. -- @since: 1.2.6
forgotPasswordHandler :: AuthHandler site Html forgotPasswordHandler :: AuthHandler site Html
forgotPasswordHandler = defaultForgotPasswordHandler forgotPasswordHandler = defaultForgotPasswordHandler
@ -260,7 +263,7 @@ class ( YesodAuth site
-- --
-- Default: 'defaultSetPasswordHandler'. -- Default: 'defaultSetPasswordHandler'.
-- --
-- @since: 1.2.6. -- @since: 1.2.6
setPasswordHandler :: setPasswordHandler ::
Bool Bool
-- ^ Whether the old password is needed. If @True@, a -- ^ Whether the old password is needed. If @True@, a
@ -347,7 +350,7 @@ emailLoginHandler toParent = do
return $ renderAuthMessage master langs msg return $ renderAuthMessage master langs msg
-- | Default implementation of 'registerHandler'. -- | Default implementation of 'registerHandler'.
-- --
-- @since: 1.2.6 -- @since 1.2.6
defaultRegisterHandler :: YesodAuthEmail master => AuthHandler master Html defaultRegisterHandler :: YesodAuthEmail master => AuthHandler master Html
defaultRegisterHandler = do defaultRegisterHandler = do
(widget, enctype) <- lift $ generateFormPost registrationForm (widget, enctype) <- lift $ generateFormPost registrationForm
@ -444,7 +447,7 @@ getForgotPasswordR = forgotPasswordHandler
-- | Default implementation of 'forgotPasswordHandler'. -- | Default implementation of 'forgotPasswordHandler'.
-- --
-- @since: 1.2.6 -- @since 1.2.6
defaultForgotPasswordHandler :: YesodAuthEmail master => AuthHandler master Html defaultForgotPasswordHandler :: YesodAuthEmail master => AuthHandler master Html
defaultForgotPasswordHandler = do defaultForgotPasswordHandler = do
(widget, enctype) <- lift $ generateFormPost forgotPasswordForm (widget, enctype) <- lift $ generateFormPost forgotPasswordForm
@ -576,7 +579,7 @@ getPasswordR = do
-- | Default implementation of 'setPasswordHandler'. -- | Default implementation of 'setPasswordHandler'.
-- --
-- @since: 1.2.6 -- @since 1.2.6
defaultSetPasswordHandler :: YesodAuthEmail master => Bool -> AuthHandler master TypedContent defaultSetPasswordHandler :: YesodAuthEmail master => Bool -> AuthHandler master TypedContent
defaultSetPasswordHandler needOld = do defaultSetPasswordHandler needOld = do
messageRender <- lift getMessageRender messageRender <- lift getMessageRender