emacs-module-0.2: Utilities to write Emacs dynamic modules
Copyright(c) Sergey Vinokurov 2022
LicenseApache-2.0 (see LICENSE)
Maintainerserg.foo@gmail.com
Safe HaskellSafe-Inferred
LanguageGHC2021

Data.Emacs.Module.Doc

Description

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

Synopsis

Documentation

data Doc Source #

Instances

Instances details
IsString Doc Source # 
Instance details

Defined in Data.Emacs.Module.Doc

Methods

fromString :: String -> Doc #

Show Doc Source # 
Instance details

Defined in Data.Emacs.Module.Doc

Methods

showsPrec :: Int -> Doc -> ShowS #

show :: Doc -> String #

showList :: [Doc] -> ShowS #

mkLiteralDoc :: Addr# -> Doc Source #

Indended to be used with unboxed string literals like this

mkLiteralDoc "foo"#

mkTextDoc :: Text -> Doc Source #

Turn abritrary bytestring into Doc.

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