haddock-location-signature

DescriptionWhere to put docstring comments in function signatures
Options
  • auto
  • leading
  • trailing
Defaultauto
Ormoluauto
SinceUnreleased

When not specified, defaults to:

Examples

func
    -- | Arg 1
    :: Int
    -- | Arg 2
    -> String
    -- | Return value
    -> Int
func ::
    -- | Arg 1
    Int ->
    -- | Arg 2
    String ->
    -- | Return value
    Int
func
    :: Int
    -- ^ Arg 1
    -> String
    -- ^ Arg 2
    -> Int
    -- ^ Return value
func ::
    Int ->
    -- ^ Arg 1
    String ->
    -- ^ Arg 2
    Int
    -- ^ Return value

For more examples, see the test files.

See also