| Safe Haskell | None |
|---|---|
| Language | Haskell98 |
Idris.Docstrings
Description
Wrapper around Markdown library
- type Docstring = Doc
- parseDocstring :: Text -> Doc
- renderDocstring :: Docstring -> Doc OutputAnnotation
- emptyDocstring :: Docstring
- nullDocstring :: Docstring -> Bool
- noDocs :: (Docstring, [(Name, Docstring)])
- overview :: Docstring -> Docstring
- containsText :: Text -> Docstring -> Bool
Documentation
parseDocstring :: Text -> Doc Source
Construct a docstring from a Text that contains Markdown-formatted docs
renderDocstring :: Docstring -> Doc OutputAnnotation Source
Convert a docstring to be shown by the pretty-printer
emptyDocstring :: Docstring Source
The empty docstring
nullDocstring :: Docstring -> Bool Source
Check whether a docstring is emtpy
overview :: Docstring -> Docstring Source
Construct a docstring consisting of the first block-level element of the argument docstring, for use in summaries.
containsText :: Text -> Docstring -> Bool Source
Does a string occur in the docstring?