hsdev-0.3.2.2: Haskell development library

Safe HaskellNone
LanguageHaskell98

HsDev.Tools.HDocs

Synopsis

Documentation

hdocsy :: PackageDbStack -> [ModuleLocation] -> [String] -> GhcM [Map String String] Source #

Get docs for modules

hdocs :: PackageDbStack -> ModuleLocation -> [String] -> GhcM (Map String String) Source #

Get docs for module

hdocsPackage :: PackageConfig -> GhcM (Map Text (Map Text Text)) Source #

Get docs for package

setSymbolDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Symbol -> m Symbol Source #

Set docs for module

setDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text Text -> Module -> m Module Source #

Set docs for module symbols

setModuleDocs :: MonadIO m => LookupTable (Text, Text) (Maybe Text) -> Map Text (Map Text Text) -> Module -> m Module Source #

Set docs for modules

readDocs :: Text -> [String] -> Path -> GhcM (Maybe (Map String String)) Source #

Read docs for one module

readModuleDocs :: [String] -> Module -> GhcM (Maybe (Map String String)) Source #

Read docs for one module