Copyright | Dai 2017 |
---|---|
License | MIT |
Maintainer | dailectic@gmail.com |
Stability | experimental |
Portability | POSIX |
Safe Haskell | None |
Language | Haskell2010 |
Documentation
docstring :: Name -> String -> Q [Dec] Source #
Add documentation string for given Name
, to be retrieved by help
.
You may want to use the str
quasiquoter for convinient multiline documentation.
(See definition for docstring
)
docstring
adds documentation to a magic global scope as a Template Haskell side effect
and so documentation for MyModule
should probably be added only in a seperate Doc
module
to avoid polluting application code