Data.Emacs.Module.Doc

Defines type that provides function's documentation that would be visible in Emacs.

Documentation

data Doc

Instances

IsString Doc

Defined in Data.Emacs.Module.Doc

Methods

fromString :: String -> Doc

Show Doc

Defined in Data.Emacs.Module.Doc

Methods

showsPrec :: Int -> Doc -> ShowS

show :: Doc -> String

showList :: [Doc] -> ShowS

mkLiteralDoc :: Addr# -> Doc

Indended to be used with unboxed string literals like this

mkLiteralDoc "foo"#

mkTextDoc :: Text -> Doc

Turn abritrary bytestring into Doc.

useDocAsCString :: Doc -> (CString -> IO a) -> IO a