Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- data HsDocString
- type LHsDocString = Located HsDocString
- mkHsDocString :: String -> HsDocString
- mkHsDocStringUtf8ByteString :: ByteString -> HsDocString
- isEmptyDocString :: HsDocString -> Bool
- unpackHDS :: HsDocString -> String
- hsDocStringToByteString :: HsDocString -> ByteString
- ppr_mbDoc :: Maybe LHsDocString -> SDoc
- appendDocs :: HsDocString -> HsDocString -> HsDocString
- concatDocs :: [HsDocString] -> Maybe HsDocString
- newtype DeclDocMap = DeclDocMap (Map Name HsDocString)
- emptyDeclDocMap :: DeclDocMap
- newtype ArgDocMap = ArgDocMap (Map Name (IntMap HsDocString))
- emptyArgDocMap :: ArgDocMap
- data ExtractedTHDocs = ExtractedTHDocs {}
Documentation
data HsDocString Source #
Haskell Documentation String
Internally this is a UTF8-Encoded ByteString
.
Instances
type LHsDocString = Located HsDocString Source #
Located Haskell Documentation String
mkHsDocString :: String -> HsDocString Source #
mkHsDocStringUtf8ByteString :: ByteString -> HsDocString Source #
Create a HsDocString
from a UTF8-encoded ByteString
.
isEmptyDocString :: HsDocString -> Bool Source #
unpackHDS :: HsDocString -> String Source #
hsDocStringToByteString :: HsDocString -> ByteString Source #
Return the contents of a HsDocString
as a UTF8-encoded ByteString
.
appendDocs :: HsDocString -> HsDocString -> HsDocString Source #
Join two docstrings.
Non-empty docstrings are joined with two newlines in between, resulting in separate paragraphs.
concatDocs :: [HsDocString] -> Maybe HsDocString Source #
Concat docstrings with two newlines in between.
Empty docstrings are skipped.
If all inputs are empty, Nothing
is returned.
newtype DeclDocMap Source #
Docs for declarations: functions, data types, instances, methods etc.
Instances
Binary DeclDocMap Source # | |
Defined in GHC.Hs.Doc put_ :: BinHandle -> DeclDocMap -> IO () Source # put :: BinHandle -> DeclDocMap -> IO (Bin DeclDocMap) Source # | |
Outputable DeclDocMap Source # | |
Defined in GHC.Hs.Doc ppr :: DeclDocMap -> SDoc Source # |
Docs for arguments. E.g. function arguments, method arguments.
data ExtractedTHDocs Source #
Maps of docs that were added via Template Haskell's putDoc
.
ExtractedTHDocs | |
|